[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Opaque objects and Emacs documentation

From: Richard Stallman
Subject: Re: Opaque objects and Emacs documentation
Date: Fri, 17 Jul 2020 21:55:35 -0400

[[[ 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. ]]]

  > to help all those 
  > who in the future, when you will have moved to something else, will work 
  > on the code you wrote.  For them it is definitely very useful to 
  > understand the implementation choices you made, the internal 
  > representations you chose to use, and so forth.  In fact, such a 
  > documentation is probably also useful for yourself, if you leave your code 
  > temporarily, and come back to it after a while.

Those explanations are very important, but they do not have to be in the
doc strings and manuals,  If including them in doc strings and manuals
is not particularly useful, we put them in comments in the source files.

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

reply via email to

[Prev in Thread] Current Thread [Next in Thread]