[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Python docstrings and licensing/authorship
|
From: |
Markus Armbruster |
|
Subject: |
Re: Python docstrings and licensing/authorship |
|
Date: |
Thu, 17 Sep 2020 14:55:03 +0200 |
|
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/27.1 (gnu/linux) |
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.
Seconded.
[...]