[Top][All Lists]

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

Re: Docstrings and manuals

From: Dmitry Gutov
Subject: Re: Docstrings and manuals
Date: Sun, 17 Apr 2016 13:50:35 +0300
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/45.0

On 04/17/2016 11:49 AM, Michael Albinus wrote:

We will always find examples where the entries in the manual are
inferior, compared with the docstring. We will also find examples with
incompatible information in the docstring and the manual.

The `mapatoms' manual entry is neither. And yet, wouldn't you agree that it's problematic?

This does not mean that manuals are useless. It only means, that there's
a bug to be fixed.

Sure. But I think that means that we should have a policy that the manual is secondary to the information contained in the source files. Right now, I have no idea which one is supposed to be the primary source of truth.

reply via email to

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