Minor docstring bug: org-footnote-goto-previous-reference

Minor docstring bug: org-footnote-goto-previous-reference

[Robert Goldman]

The docstring for the command "org-footnote-goto-previous-reference" is

   Find the next previous of the footnote with label LABEL.

...which I can't actually parse.

"Find the (immediately) previous reference to the footnote with label
LABEL."

Is that better?

Cheers,
r

Re: Minor docstring bug: org-footnote-goto-previous-reference

[Noorul Islam]

[-- Attachment #1: Type: text/plain, Size: 593 bytes --]

On Sun, Oct 24, 2010 at 5:00 AM, Robert Goldman <rpgoldman@sift.info> wrote:
> The docstring for the command "org-footnote-goto-previous-reference" is
>
>   Find the next previous of the footnote with label LABEL.
>
> ...which I can't actually parse.
>
> "Find the (immediately) previous reference to the footnote with label
> LABEL."
>
> Is that better?
>

Patch is attached. I modified it a bit.

Fix doc string

* lisp/org-footnote.el (org-footnote-goto-previous-reference): Fix doc string

Proposed by Robert Goldman <rpgoldman@sift.info>

Thanks and Regards
Noorul

[-- Attachment #2: org-footnote.el.txt --]
[-- Type: text/plain, Size: 627 bytes --]

diff --git a/lisp/org-footnote.el b/lisp/org-footnote.el
index 36fcfb2..1ce1815 100644
--- a/lisp/org-footnote.el
+++ b/lisp/org-footnote.el
@@ -188,7 +188,7 @@ with start and label of the footnote if there is a definition at point."
       (message "Edit definition and go back with `C-c &' or, if unique, with `C-c C-c'."))))
 
 (defun org-footnote-goto-previous-reference (label)
-  "Find the next previous of the footnote with label LABEL."
+  "Find the immediate previous reference of the footnote with label LABEL."
   (interactive "sLabel: ")
   (org-mark-ring-push)
   (setq label (org-footnote-normalize-label label))

[-- 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: Minor docstring bug: org-footnote-goto-previous-reference

[T.F. Torrey]

> Date: Sun, 24 Oct 2010 08:57:35 +0530
> Subject: Re: [Orgmode] Minor docstring bug:
> 	org-footnote-goto-previous-reference
> From: Noorul Islam <noorul@noorul.com>
> To: rpgoldman@sift.info
> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 2)
> Cc: Org Mode <emacs-orgmode@gnu.org>
> Sender: emacs-orgmode-bounces+tftorrey=tftorrey.com@gnu.org
> 
> On Sun, Oct 24, 2010 at 5:00 AM, Robert Goldman <rpgoldman@sift.info> wrote:
> > The docstring for the command "org-footnote-goto-previous-reference" is
> >
> >   Find the next previous of the footnote with label LABEL.
> >
> > ...which I can't actually parse.
> >
> > "Find the (immediately) previous reference to the footnote with label
> > LABEL."
> >
> > Is that better?
> >
> 
> Patch is attached. I modified it a bit.

Noorul,

Actually, your modification makes it grammatically incorrect. The word
"immediately" is to modify the adjective "previous", and in English, an
adjective needs to be modified by an adverb. So, "immediately previous"
would be correct, but "immediate previous" is not.

Trying to be helpful, not merely nit-picking,
Terry

> Fix doc string
> 
> * lisp/org-footnote.el (org-footnote-goto-previous-reference): Fix doc string
> 
> Proposed by Robert Goldman <rpgoldman@sift.info>
> 
> Thanks and Regards
> Noorul
> _______________________________________________
> 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: Minor docstring bug: org-footnote-goto-previous-reference

[Noorul Islam]

[-- Attachment #1: Type: text/plain, Size: 1353 bytes --]

On Sun, Oct 24, 2010 at 12:56 PM, T.F. Torrey <tftorrey@tftorrey.com> wrote:
>> Date: Sun, 24 Oct 2010 08:57:35 +0530
>> Subject: Re: [Orgmode] Minor docstring bug:
>>       org-footnote-goto-previous-reference
>> From: Noorul Islam <noorul@noorul.com>
>> To: rpgoldman@sift.info
>> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 2)
>> Cc: Org Mode <emacs-orgmode@gnu.org>
>> Sender: emacs-orgmode-bounces+tftorrey=tftorrey.com@gnu.org
>>
>> On Sun, Oct 24, 2010 at 5:00 AM, Robert Goldman <rpgoldman@sift.info> wrote:
>> > The docstring for the command "org-footnote-goto-previous-reference" is
>> >
>> >   Find the next previous of the footnote with label LABEL.
>> >
>> > ...which I can't actually parse.
>> >
>> > "Find the (immediately) previous reference to the footnote with label
>> > LABEL."
>> >
>> > Is that better?
>> >
>>
>> Patch is attached. I modified it a bit.
>
> Noorul,
>
> Actually, your modification makes it grammatically incorrect. The word
> "immediately" is to modify the adjective "previous", and in English, an
> adjective needs to be modified by an adverb. So, "immediately previous"
> would be correct, but "immediate previous" is not.
>
> Trying to be helpful, not merely nit-picking,

I can understand. Attached is the modified patch.

Thanks and Regards
Noorul

[-- Attachment #2: org-footnote.el.txt --]
[-- Type: text/plain, Size: 629 bytes --]

diff --git a/lisp/org-footnote.el b/lisp/org-footnote.el
index 36fcfb2..1ce1815 100644
--- a/lisp/org-footnote.el
+++ b/lisp/org-footnote.el
@@ -188,7 +188,7 @@ with start and label of the footnote if there is a definition at point."
       (message "Edit definition and go back with `C-c &' or, if unique, with `C-c C-c'."))))
 
 (defun org-footnote-goto-previous-reference (label)
-  "Find the next previous of the footnote with label LABEL."
+  "Find the immediately previous reference of the footnote with label LABEL."
   (interactive "sLabel: ")
   (org-mark-ring-push)
   (setq label (org-footnote-normalize-label label))

[-- 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