8000 RFC Consistency for meta infos in files (license, encoding, authors, ..) · Issue #20813 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]

Skip to content
RFC Consistency for meta infos in files (license, encoding, authors, ..) #20813
Closed
@lorentzenchr

Description

@lorentzenchr

There are several pieces of information that some files contain, others do not, examples are:

  • # -*- coding: utf-8 -*- at the beginning of a file
  • License information, eg # License: BSD 3 clause
  • List of (some main) authors for that file, # Authors:

For the following reasons, I'd like to remove the encoding info, and have a consistent policy for the other 2 points:

  • As a (newish) contributor, it's hard to figure out what is expected.
  • Having those infos consistent in all files might help a tiny little bit to generate trust in the production-readiness of scikit-learn.

I haven't figured out a convincing policy for authors, maybe leave it as is.

Note that changes of those lines of code shouldn't produce merge conflicts, cross referencing #11336.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0