From: John Snow <jsnow@redhat.com>
To: "Markus Armbruster" <armbru@redhat.com>,
"Daniel P. Berrangé" <berrange@redhat.com>
Cc: Christophe de Dinechin <cdupontd@redhat.com>,
QEMU Developers <qemu-devel@nongnu.org>
Subject: Re: Python docstrings and licensing/authorship
Date: Thu, 17 Sep 2020 15:02:35 -0400 [thread overview]
Message-ID: <1b0824ca-f4f7-8be6-1799-013d7a7766bd@redhat.com> (raw)
In-Reply-To: <87mu1o4l7c.fsf@dusky.pond.sub.org>
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.
>
> Seconded.
>
*slams gavel*
That's consensus, folks! Thanks.
prev parent reply other threads:[~2020-09-17 19:06 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-16 15:47 Python docstrings and licensing/authorship John Snow
2020-09-16 16:05 ` Christophe de Dinechin
2020-09-16 16:22 ` John Snow
2020-09-16 16:37 ` Daniel P. Berrangé
2020-09-17 12:55 ` Markus Armbruster
2020-09-17 19:02 ` John Snow [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1b0824ca-f4f7-8be6-1799-013d7a7766bd@redhat.com \
--to=jsnow@redhat.com \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=cdupontd@redhat.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).