Skip to content

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

Open

Description

@g1itch

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.

Activity

  1. g1itch commented on Nov 21, 2019

    @g1itch
    CollaboratorAuthor

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

  2. reopened this on Dec 20, 2019
  3. g1itch commented on Dec 20, 2019

    @g1itch
    CollaboratorAuthor

    I see it again in #1554

  4. PeterSurda commented on Jan 10, 2020

    @PeterSurda
    Member

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

  5. added this to the v0.7.0 milestone on Aug 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions