search

prithviulm / qudi-core

A framework for modular measurement applications.
https://qudi-core-testing.readthedocs.io/en/latest/
GNU General Public License v3.0
0 stars 2 forks source link

Does the license need to be there at the head of almost every file? [Suggestion] #9

Closed prithviulm closed 2 weeks ago

prithviulm commented 6 months ago

Suggestion

Right now we have the boilerplate license text at the top of many files. I don't know if this is necessary due to license terms and such, but it is affecting the docs building because it's getting parsed. One could write some rule to exclude the text in the docs building probably.

Reasons

Code is slightly cleaner.

Additional Context

Also, the copyright year can/ should be updated every year (does it need to be?) Right now most of them say copyright 2021. I'm not sure how the year in the source code can be automatically updated every year but the docs build can certainly have the year updated automatically, though it's probably problematic if the rtd docs and source code have differing copyright years.

prithviulm commented 2 weeks ago

Fixed. The license needs to be there in every file but we have excluded it from the docs.