Bug: inconsistent docstring of org-agenda-prefix-format [7.6 (release_7.6.143.g98b7c)]

Bug: inconsistent docstring of org-agenda-prefix-format [7.6 (release_7.6.143.g98b7c)]

[Tassilo Horn]

Remember to cover the basics, that is, what you expected to happen and
what in fact did happen.  You don't know how to make a good report?  See

     http://orgmode.org/manual/Feedback.html#Feedback

Your bug report will be posted to the Org-mode mailing list.
------------------------------------------------------------------------

The docstring of `org-agenda-prefix-format' is heavily broken.  First it
says

  An alist with four entries, for the different agenda types.

and then it goes on enumerating *five* keys:

  The keys to the sublists are `agenda', `timeline', `todo', `search'
  and `tags'.

And finally, it presents an example where the value is not an alist but
a simple string.

  As another example, if you don't want the time-of-day of entries in
  the prefix, you could use:

    (setq org-agenda-prefix-format "  %-11:c% s")



Emacs  : GNU Emacs 24.0.50.1 (x86_64-pc-linux-gnu, GTK+ Version 3.0.11)
 of 2011-07-18 on thinkpad
Package: Org-mode version 7.6 (release_7.6.143.g98b7c)

Re: Bug: inconsistent docstring of org-agenda-prefix-format [7.6 (release_7.6.143.g98b7c)]

[Bastien]

Tassilo Horn <tassilo@member.fsf.org> writes:

> The docstring of `org-agenda-prefix-format' is heavily broken.  

I just pushed a fix, I tried to improve the docstring.

Let me know if this is clearer and less buggy.

Thanks!

-- 
 Bastien

Re: Bug: inconsistent docstring of org-agenda-prefix-format [7.6 (release_7.6.143.g98b7c)]

[Tassilo Horn]

Bastien <bzg@altern.org> writes:

Hi Bastien,

>> The docstring of `org-agenda-prefix-format' is heavily broken.
>
> I just pushed a fix, I tried to improve the docstring.
>
> Let me know if this is clearer and less buggy.

Yes, it's much better now. :-)

Bye,
Tassilo