all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Ted Zlatanov <tzz@lifelogs.com>
To: emacs-devel@gnu.org
Subject: Re: GnuTLS and zeroing keys in Emacs
Date: Mon, 17 Jul 2017 10:07:11 -0400	[thread overview]
Message-ID: <87lgnndunk.fsf@lifelogs.com> (raw)
In-Reply-To: 40a0b98c-fa93-2183-a4fb-141683f8a042@cs.ucla.edu

On Sun, 16 Jul 2017 17:29:09 -0700 Paul Eggert <eggert@cs.ucla.edu> wrote: 

PE> I restored those particular comments by installing the attached patch. That
PE> being said, I found the comments to have more cost (in terms of clutter) than
PE> benefit (in terms of useful information conveyed), and similarly for some nearby
PE> comments that I also removed. 

Understood. I think this is a balancing act for sure. Thank you for
restoring some of the comments.

PE> Doc strings for functions should use the imperative form, as it is typically
PE> shorter and less likely to be misunderstood. For example the doc string for the
PE> 'length' function begins "Return the length of ...".

I had never noticed that in the docs, and it's explained already in
doc/lispref/tips.texi so I'll make sure to re-read those tips :) Thanks!

Ted




      reply	other threads:[~2017-07-17 14:07 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-07-14 23:42 GnuTLS and zeroing keys in Emacs Paul Eggert
2017-07-15 19:00 ` Ted Zlatanov
2017-07-16 23:53   ` Paul Eggert
2017-07-17 13:52     ` Ted Zlatanov
2017-07-17  0:29   ` Paul Eggert
2017-07-17 14:07     ` Ted Zlatanov [this message]

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

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

  git send-email \
    --in-reply-to=87lgnndunk.fsf@lifelogs.com \
    --to=tzz@lifelogs.com \
    --cc=emacs-devel@gnu.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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.