|
From: | Dmitry Gutov |
Subject: | Re: Trunk still not open |
Date: | Sun, 16 Mar 2014 02:32:30 +0200 |
User-agent: | Mozilla/5.0 (X11; Linux x86_64; rv:24.0) Gecko/20100101 Thunderbird/24.3.0 |
On 15.03.2014 10:45, Eli Zaretskii wrote:
The doc strings and the manuals take different views on the same features. The doc strings document only the symbol they pertain to, with minimal links to others. By contrast, the manuals should always describe the features in the context of a larger theme that is the subject of the containing section of the manual. This means, in particular, that the manual text should: ...
Thanks, that's a good list, and it explain well why one may want to document core functionality and concepts in a manual.
I'm not so sure about plain variables and functions.
It is quite rare to have a feature whose documentation in the manual is simply a repetition of its doc string.
If it's not radically different, I'd still question the separation. Maybe that's often a cause the improve the docstring, rather than rewrite the same information in different ways?
I see that no one has commented on "documenting the changes in triplicate".
[Prev in Thread] | Current Thread | [Next in Thread] |