Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lic docstring messing up user documentation #24

Closed
shimwell opened this issue Jun 23, 2020 · 1 comment
Closed

lic docstring messing up user documentation #24

shimwell opened this issue Jun 23, 2020 · 1 comment

Comments

@shimwell
Copy link
Collaborator

Including the lic header on each file is breaking the user documentation as shown in screen shot below.

Additionally there is a large maintenance burden to keeping the file lic header the same across every file

Additionally this lic header does not appear to be standard practice looking at other git repositories. The standard practice is to include a LICENSE.md or LICENSE in the root of the repository. This then allows github to automatically detect the license type.

Screenshot from 2020-06-23 11-29-36

@shimwell
Copy link
Collaborator Author

This has been fixed with this commit 8dfc887

1000 lines of code saved

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant