unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Dmitry Gutov <dgutov@yandex.ru>
To: Reuben Thomas <rrt@sc3d.org>
Cc: 24745@debbugs.gnu.org
Subject: bug#24745: 25.1.50; whitespace.el: fix beginning/end of buffer checks
Date: Wed, 26 Oct 2016 01:45:34 +0300	[thread overview]
Message-ID: <39a8c955-928a-1551-3943-b8ccfda38eca@yandex.ru> (raw)
In-Reply-To: <CAOnWdohXbozzfjFPY2u1uWcvz+m7pNoEVzszoHi_bBNG2DyThQ@mail.gmail.com>

On 25.10.2016 21:44, Reuben Thomas wrote:

> I should check some context: my understanding is that inline
> documentation in .el files is mainly useful for high-level documentation
> for standalone packages. Packages that form part of Emacs should be
> documented in the manual (as whitespace.el is); details of functions and
> variables should be in docstrings (as is the case for whitespace.el).
> The docstrings of customizable options are readable in the customize
> interface.

Maybe you're right. I'd leave at least "to change behavior, do M-x 
customize-group whitespace", though. Maybe someone else would like to 
weigh in.

> ​Apologies. As far as I could see, the main things that were wrong were
> the summary lines and the lack of function names (or equivalent) in the
> detailed log. I have rewritten all of them.

You're close, but:

- Sentences should start with a capital letter.
- The function names are usually reflowed in a different way (you can 
put several of them in parentheses, but each such groups only spans one 
line). Try copying the message from the first patch to a ChangeLog file, 
and press M-q to see that in action.
- The messages should references this bug report.
- The file should be consistently referred to as lisp/whitespace.el.

You can automate the adherence to most of these rules by first entering 
the messages in a local-only ChangeLog file, using 'C-x 4 a'. Also see 
"Generating ChangeLog entries" in CONTRIBUTE.

> I have rebased the patch series against master and attach the new version.

Thanks. Do you have commit access?





  reply	other threads:[~2016-10-25 22:45 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-10-20 12:32 bug#24745: 25.1.50; whitespace.el: fix beginning/end of buffer checks Reuben Thomas
2016-10-20 22:43 ` Dmitry Gutov
2016-10-21 14:42   ` Reuben Thomas
2016-10-21 14:45     ` Dmitry Gutov
2016-10-21 14:52       ` Reuben Thomas
2016-10-24 23:36         ` Dmitry Gutov
2016-10-25 18:44           ` Reuben Thomas
2016-10-25 22:45             ` Dmitry Gutov [this message]
2016-10-25 23:26               ` Reuben Thomas
2016-11-01 15:32                 ` Reuben Thomas
2016-11-03  1:07                   ` Dmitry Gutov
2016-11-03 12:39                     ` Reuben Thomas
2016-11-03  1:06                 ` Dmitry Gutov
2016-11-03 12:38                   ` Reuben Thomas
     [not found] ` <handler.24745.B.14769667565022.ack@debbugs.gnu.org>
2016-10-21 14:38   ` bug#24745: Acknowledgement (25.1.50; whitespace.el: fix beginning/end of buffer checks) Reuben Thomas

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=39a8c955-928a-1551-3943-b8ccfda38eca@yandex.ru \
    --to=dgutov@yandex.ru \
    --cc=24745@debbugs.gnu.org \
    --cc=rrt@sc3d.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).