[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Docstrings and manuals
From: |
Richard Stallman |
Subject: |
Re: Docstrings and manuals |
Date: |
Mon, 18 Apr 2016 20:25:36 -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. ]]]
> How come it can be more important to mention in the manual? Returning
> nil is either a part of the function's contract, or not.
We don't divide up the function's behaviors in that all-or-nothing way.
Since the return value is documented in the manual, it is something
we would not change without a good reason. However, that doesn't mean
it needs to be stated in the doc string.
--
Dr Richard Stallman
President, Free Software Foundation (gnu.org, fsf.org)
Internet Hall-of-Famer (internethalloffame.org)
Skype: No way! See stallman.org/skype.html.
- Re: Docstrings and manuals, (continued)
- Re: Docstrings and manuals, Eli Zaretskii, 2016/04/17
- Re: Docstrings and manuals, Dmitry Gutov, 2016/04/17
- Re: Docstrings and manuals, Eli Zaretskii, 2016/04/17
- Re: Docstrings and manuals, Dmitry Gutov, 2016/04/17
- Re: Docstrings and manuals, Eli Zaretskii, 2016/04/17
- Re: Docstrings and manuals, Richard Stallman, 2016/04/18
- Re: Docstrings and manuals, Dmitry Gutov, 2016/04/18
- Re: Docstrings and manuals,
Richard Stallman <=
- Re: Docstrings and manuals, Dmitry Gutov, 2016/04/19
- Re: Docstrings and manuals, Richard Stallman, 2016/04/19