From: John Snow <jsnow@redhat.com>
To: QEMU Developers <qemu-devel@nongnu.org>
Subject: Python docstrings and licensing/authorship
Date: Wed, 16 Sep 2020 11:47:21 -0400 [thread overview]
Message-ID: <361aad7f-c2a3-524e-bd5a-2fc1fa6fe38a@redhat.com> (raw)
For some of the Python cleanup work I am doing, I am moving preamble
comments into docstrings. These docstrings are visible in interactive
editors and may be visible when using Sphinx to generate documentation
manuals for Python code.
My instinct is to remove the licensing and authorship information from
the preamble and leave the docstring only with information functionally
relevant to the module, while leaving licensing and authorship
information in a comment (above? below?).
The end effect would be that using e.g. `help(qapi.parser)` in the
interactive Python shell would not show licensing or copyright for the
module, but it would still be visible in the source file, as always.
Is this in bad taste? Do we have strong feelings about authorship and
licensing being visible in help output and generated documentation?
--js
next reply other threads:[~2020-09-16 15:56 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-16 15:47 John Snow [this message]
2020-09-16 16:05 ` Python docstrings and licensing/authorship 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
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=361aad7f-c2a3-524e-bd5a-2fc1fa6fe38a@redhat.com \
--to=jsnow@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).