Should licence headers be turned into docstrings or remain a comments? #1435

Open
opened 2019-02-12 12:45:06 +01:00 by g1itch · 3 comments
g1itch commented 2019-02-12 12:45:06 +01:00 (Migrated from github.com)

Hello!

That's the question arisen by recent rebase I've done (7f96b36). Some modules taken from third party (like namecoin or network.asyncore_pollchoose) have the licence headers which were turned into docstrings by @coffeedogs. Though I've seen a python packages with similar formatting style (like jsonrpclib) I still don't understand the reason to have the licenses in documentation.

Let's clarify the bitmessage's style guide in this case.

Hello! That's the question arisen by recent rebase I've done (7f96b36). Some modules taken from third party (like `namecoin` or `network.asyncore_pollchoose`) have the licence headers which were turned into docstrings by @coffeedogs. Though I've seen a python packages with similar formatting style (like `jsonrpclib`) I still don't understand the reason to have the licenses in documentation. Let's clarify the bitmessage's style guide in this case.
g1itch commented 2019-11-21 17:38:27 +01:00 (Migrated from github.com)

I assume they should remain comments or turned back into comments.

I assume they should remain comments or turned back into comments.
g1itch commented 2019-12-20 14:36:54 +01:00 (Migrated from github.com)

I see it again in #1554

I see it again in #1554
PeterSurda commented 2020-01-10 14:57:31 +01:00 (Migrated from github.com)

I would say we add licenses of individual files into the LICENSE file in project root.

I would say we add licenses of individual files into the `LICENSE` file in project root.
This repo is archived. You cannot comment on issues.
No Milestone
No project
No Assignees
1 Participants
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: Bitmessage/PyBitmessage-2024-12-19#1435
No description provided.