[PATCH] org-export-format-drawer-function docstring

[PATCH] org-export-format-drawer-function docstring

[Diogo F. S. Ramos]

[-- Attachment #1: Type: Text/Plain, Size: 387 bytes --]

Hello,

I would like to suggest a little change in the documentation. The
presented order of the parameters in the description of
`org-export-format-drawer-function' gives the false impression that
that is the order which the user function needs to list its
parameters. The right order -- at least using the development version
-- would be `name content backend'.

-- 
Diogo F. S. Ramos

[-- Attachment #2: file.patch --]
[-- Type: Text/X-Patch, Size: 726 bytes --]

diff --git a/org-configs/org-hooks.org b/org-configs/org-hooks.org
index 50a5516..1922d09 100644
--- a/org-configs/org-hooks.org
+++ b/org-configs/org-hooks.org
@@ -711,9 +711,9 @@ Defined in: /org-exp.el/
 #+begin_example
     Function to be called to format the contents of a drawer.
     The function must accept three parameters:
-      BACKEND  one of the symbols html, docbook, latex, ascii, xoxo
       NAME     the drawer name, like \"PROPERTIES\"
       CONTENT  the content of the drawer.
+      BACKEND  one of the symbols html, docbook, latex, ascii, xoxo
     The function should return the text to be inserted into the buffer.
     If this is nil, `org-export-format-drawer' is used as a default.
 #+end_example

[-- Attachment #3: Type: text/plain, Size: 201 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: [PATCH] org-export-format-drawer-function docstring

[Carsten Dominik]

Applied, thanks for catching this!

- Carsten

On Apr 24, 2010, at 3:05 PM, Diogo F. S. Ramos wrote:

> Hello,
>
> I would like to suggest a little change in the documentation. The
> presented order of the parameters in the description of
> `org-export-format-drawer-function' gives the false impression that
> that is the order which the user function needs to list its
> parameters. The right order -- at least using the development version
> -- would be `name content backend'.
>
> --  
> Diogo F. S. Ramos
> diff --git a/org-configs/org-hooks.org b/org-configs/org-hooks.org
> index 50a5516..1922d09 100644
> --- a/org-configs/org-hooks.org
> +++ b/org-configs/org-hooks.org
> @@ -711,9 +711,9 @@ Defined in: /org-exp.el/
> #+begin_example
>     Function to be called to format the contents of a drawer.
>     The function must accept three parameters:
> -      BACKEND  one of the symbols html, docbook, latex, ascii, xoxo
>       NAME     the drawer name, like \"PROPERTIES\"
>       CONTENT  the content of the drawer.
> +      BACKEND  one of the symbols html, docbook, latex, ascii, xoxo
>     The function should return the text to be inserted into the  
> buffer.
>     If this is nil, `org-export-format-drawer' is used as a default.
> #+end_example
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode

- Carsten