unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Richard Stallman <rms@gnu.org>
To: "Björn Bidar" <bjorn.bidar@thaodan.de>
Cc: 74965@debbugs.gnu.org, rwl@recursewithless.net
Subject: bug#74965: [PATCH] Document representation of dates in calendar.el
Date: Tue, 24 Dec 2024 23:48:14 -0500	[thread overview]
Message-ID: <E1tQJJe-0002UB-3C@fencepost.gnu.org> (raw)
In-Reply-To: <87ikrav96y.fsf@> (message from Björn Bidar on Mon, 23 Dec 2024 15:08:05 +0200)

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

  > There are some modes which could have more documentation on internal
  > functions to explain better what they are doing such as in Gnus.

Yes, that is crucial for clear code.

But what we really want, to make a program easy to read and
understand, goes beyond that.  It should have an introduction which
explains the parts of the program, and how they relate in terms of
jobs they do, and what the entry points are for each part.

Patr of this is explicitly dividng the program into parts
and starting each part with a comment saying what that part does
and how to use it.

-- 
Dr Richard Stallman (https://stallman.org)
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)







  parent reply	other threads:[~2024-12-25  4:48 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-12-19  8:39 bug#74965: Document date representations in calendar Richard Lawrence
2024-12-19  8:46 ` bug#74965: [PATCH] Document representation of dates in calendar.el Richard Lawrence
2024-12-21 11:01   ` Eli Zaretskii
2024-12-23  4:11   ` Richard Stallman
     [not found]     ` <87ikrav96y.fsf@>
2024-12-25  4:48       ` Richard Stallman [this message]
     [not found]     ` <87pllin5se.fsf@recursewithless.net>
2024-12-25  4:48       ` Richard Stallman

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=E1tQJJe-0002UB-3C@fencepost.gnu.org \
    --to=rms@gnu.org \
    --cc=74965@debbugs.gnu.org \
    --cc=bjorn.bidar@thaodan.de \
    --cc=rwl@recursewithless.net \
    /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).