Re: [Emacs-diffs] trunk r114939: * lisp/progmodes/ruby-mode.el (ruby-mode): Clean up docstring.

Re: [Emacs-diffs] trunk r114939: * lisp/progmodes/ruby-mode.el (ruby-mode): Clean up docstring.

[Stefan Monnier]

> +Entry to this mode calls the value of `ruby-mode-hook'
> +if that value is non-nil."

That's problematic:
- it's redundant since define-derived-mode already adds "In addition to
  any hooks its parent mode `prog-mode' might have run,\nthis mode runs
  the hook `ruby-mode-hook', as the final step\nduring initialization."
- hooks aren't "called" but are "run".
- it's not just "the value of `ruby-mode-hook'", but the *values*, since
  hooks use both the buffer-local and the global value of the symbol.
- the hook is run even if it is nil (or unbound): running it will simply
  not do anything.


        Stefan

Re: [Emacs-diffs] trunk r114939: * lisp/progmodes/ruby-mode.el (ruby-mode): Clean up docstring.

[Bozhidar Batsov]

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

I didn't like this as well, but I added it since that exact text appears in
the docstrings of many major modes. I though it was something like an
unwritten convention, but I guess many people have simply been copy-pasting
the same code over the years.  I'll have it removed.


On 4 November 2013 18:43, Stefan Monnier <monnier@iro.umontreal.ca> wrote:

> > +Entry to this mode calls the value of `ruby-mode-hook'
> > +if that value is non-nil."
>
> That's problematic:
> - it's redundant since define-derived-mode already adds "In addition to
>   any hooks its parent mode `prog-mode' might have run,\nthis mode runs
>   the hook `ruby-mode-hook', as the final step\nduring initialization."
> - hooks aren't "called" but are "run".
> - it's not just "the value of `ruby-mode-hook'", but the *values*, since
>   hooks use both the buffer-local and the global value of the symbol.
> - the hook is run even if it is nil (or unbound): running it will simply
>   not do anything.
>
>
>         Stefan
>

[-- Attachment #2: Type: text/html, Size: 1507 bytes --]

Re: [Emacs-diffs] trunk r114939: * lisp/progmodes/ruby-mode.el (ruby-mode): Clean up docstring.

[Bozhidar Batsov]

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

This text should probably be removed from the description of other major
modes as well, right?


On 4 November 2013 19:04, Bozhidar Batsov <bozhidar@batsov.com> wrote:

> I didn't like this as well, but I added it since that exact text appears
> in the docstrings of many major modes. I though it was something like an
> unwritten convention, but I guess many people have simply been copy-pasting
> the same code over the years.  I'll have it removed.
>
>
> On 4 November 2013 18:43, Stefan Monnier <monnier@iro.umontreal.ca> wrote:
>
>> > +Entry to this mode calls the value of `ruby-mode-hook'
>> > +if that value is non-nil."
>>
>> That's problematic:
>> - it's redundant since define-derived-mode already adds "In addition to
>>   any hooks its parent mode `prog-mode' might have run,\nthis mode runs
>>   the hook `ruby-mode-hook', as the final step\nduring initialization."
>> - hooks aren't "called" but are "run".
>> - it's not just "the value of `ruby-mode-hook'", but the *values*, since
>>   hooks use both the buffer-local and the global value of the symbol.
>> - the hook is run even if it is nil (or unbound): running it will simply
>>   not do anything.
>>
>>
>>         Stefan
>>
>
>

[-- Attachment #2: Type: text/html, Size: 2012 bytes --]

Re: [Emacs-diffs] trunk r114939: * lisp/progmodes/ruby-mode.el (ruby-mode): Clean up docstring.

[Stefan Monnier]

> This text should probably be removed from the description of other major
> modes as well, right?

Sure (if they use define-derived-mode).


        Stefan

Re: [Emacs-diffs] trunk r114939: * lisp/progmodes/ruby-mode.el (ruby-mode): Clean up docstring.

[Bozhidar Batsov]

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

OK. I've removed the text from the most prominent mode docstrings. The
chance of someone running across it now will be significantly smaller.


On 4 November 2013 20:50, Stefan Monnier <monnier@iro.umontreal.ca> wrote:

> > This text should probably be removed from the description of other major
> > modes as well, right?
>
> Sure (if they use define-derived-mode).
>
>
>         Stefan
>

[-- Attachment #2: Type: text/html, Size: 811 bytes --]

Re: [Emacs-diffs] trunk r114939: * lisp/progmodes/ruby-mode.el (ruby-mode): Clean up docstring.

[Stefan Monnier]

> OK. I've removed the text from the most prominent mode docstrings.  The
> chance of someone running across it now will be significantly smaller.

Thanks.  I fixed your ChangeLog so it fits within 80 columns.
Take a look also at how I compressed it ;-)


        Stefan

Re: [Emacs-diffs] trunk r114939: * lisp/progmodes/ruby-mode.el (ruby-mode): Clean up docstring.

[Bozhidar Batsov]

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

Will do! I definitely wasn't sure what was the expected way to write that
particular entry. Thanks for cleaning it up!


On 5 November 2013 19:01, Stefan Monnier <monnier@iro.umontreal.ca> wrote:

> > OK. I've removed the text from the most prominent mode docstrings.  The
> > chance of someone running across it now will be significantly smaller.
>
> Thanks.  I fixed your ChangeLog so it fits within 80 columns.
> Take a look also at how I compressed it ;-)
>
>
>         Stefan
>

[-- Attachment #2: Type: text/html, Size: 911 bytes --]