all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Stefan Kangas <stefan@marxist.se>
To: 35994@debbugs.gnu.org
Subject: bug#35994: Remove leading '*' from defcustom docstring todo considered done
Date: Wed, 29 May 2019 19:55:01 +0200	[thread overview]
Message-ID: <CADwFkmn3EGmn5MYte2DxWzfGOGkTMri2KdFuqaxEcjpeLXus5g@mail.gmail.com> (raw)

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

I looked into the following item in etc/TODO:

> ** Remove any leading '*'s from defcustom doc-strings.
> [done?] [A lot of them are in CC Mode.]

I couldn't find one example.  Therefore, I propose that this should be
considered done.  I've attached a patch that removes the TODO.

I carried out the following steps, in case anyone wants to verify:

1. find . -type f -name "*.el" -exec grep -Hn -A20 "(defcustom" {} \; > output
2. grep '\*' output > output.filtered
3. Checked output.filtered manually (<< least fun step)

I'm sure there's a better way to do this, but I couldn't be bothered to think of
one.

Thanks,
Stefan Kangas

[-- Attachment #2: 0001-etc-TODO-Remove-done-TODO-to-remove-leading-from-def.patch --]
[-- Type: application/octet-stream, Size: 840 bytes --]

From b00e25b6a7caf8de7e874613377223125c85cb93 Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefankangas@gmail.com>
Date: Wed, 29 May 2019 18:49:07 +0200
Subject: [PATCH] * etc/TODO: Remove done TODO to remove leading "*" from
 defcustoms.

---
 etc/TODO | 3 ---
 1 file changed, 3 deletions(-)

diff --git a/etc/TODO b/etc/TODO
index fe2e583a38..0f93279fa6 100644
--- a/etc/TODO
+++ b/etc/TODO
@@ -125,9 +125,6 @@ to use it.
 ** Convert all defvars with leading '*' in the doc-strings into defcustoms
 of appropriate :type and :group.
 
-** Remove any leading '*'s from defcustom doc-strings.
-[done?] [A lot of them are in CC Mode.]
-
 ** Remove unnecessary autoload cookies from defcustoms.
 This needs a bit of care, since often people have become used to
 expecting such variables to always be defined, eg when they modify
-- 
2.21.0


             reply	other threads:[~2019-05-29 17:55 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-29 17:55 Stefan Kangas [this message]
2019-05-30  1:48 ` bug#35994: Remove leading '*' from defcustom docstring todo considered done Basil L. Contovounesios
2019-06-03  0:43   ` Stefan Kangas
2019-06-09  7:12     ` Eli Zaretskii

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=CADwFkmn3EGmn5MYte2DxWzfGOGkTMri2KdFuqaxEcjpeLXus5g@mail.gmail.com \
    --to=stefan@marxist.se \
    --cc=35994@debbugs.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.