[Top][All Lists]

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

Re: Python docstrings and licensing/authorship

From: John Snow
Subject: Re: Python docstrings and licensing/authorship
Date: Thu, 17 Sep 2020 15:02:35 -0400
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.11.0

On 9/17/20 8:55 AM, Markus Armbruster wrote:
Daniel P. Berrangé <berrange@redhat.com> writes:

On Wed, Sep 16, 2020 at 12:22:37PM -0400, John Snow wrote:
The real question I have is if anyone thinks it would be "rude" to separate
out any of the comment preambles (currently not visible at runtime or docs
in any way, shape or form!) into two pieces:

1. Functional stuff relating to the usage of the module, visible in
help(module_name), visible in generated docs, visible in IDE popups, etc.

2. Authorship/copyright and licensing info, not visible in the above places.

I think this makes sense. IME it is not common to include copyright /
author info the module help text, as that s non-technical information.


*slams gavel*

That's consensus, folks! Thanks.

reply via email to

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