-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Code for automatically updating license headers #2028
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
identified some incorrectly updated headers
deeplabcut/pose_estimation_tensorflow/backbones/efficientnet_builder.py
Outdated
Show resolved
Hide resolved
deeplabcut/pose_estimation_tensorflow/datasets/pose_deterministic.py
Outdated
Show resolved
Hide resolved
deeplabcut/pose_estimation_tensorflow/datasets/pose_scalecrop.py
Outdated
Show resolved
Hide resolved
6cacf46
to
bc865f1
Compare
@AlexEMG pls see my changes: It is not possible to configure various license statements directly in For updating license headers in the whole repository, simply run
now. Some TODOs:
|
"It should be decided where to put the update_license_headers.py helper script. Afaik there is not "developer tools" directory right now. The options I can think of are: (1) leave it in the repo root (2) put it in .github or (3) add it to deeplabcut.utils. Opinions?"
|
983cdc4
to
f605b7a
Compare
More updates:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @stes!
More updates:
tools
directory for future developer tools (like pre-commit functions, etc.)Some updates:
It is not possible to configure various license statements directly in
NOTICE.yml
. This is also useful in general to have an overview over third partly licenses applicable to the code.For updating license headers in the whole repository, simply run
now. Some TODOs:
update_license_headers.py
helper script. Afaik there is not "developer tools" directory right now. The options I can think of are: (1) leave it in the repo root (2) put it in.github
or (3) add it todeeplabcut.utils
. Opinions?Original PR description
Prior to this PR, the license headers in the codebase had two issues:
__doc__
variable becauseThis PR proposes the following changes:
#
instead of tripe quotes ("""
). This avoids a clash between the module docstring and makes it easier to write API docs on module level.tests/
andexamples/
"DeepLabCut2.0-2.3 Toolbox" (the version info could optionally also be automatically inserted, if desired)DeepLabCut Toolbox.copyright.tmpl
fileThe headers can always be updated by running (this can be automated and e.g. be added to a script that also triggers code formatting w/ black, etc):
TODO (for maintainers):
.copyright.tmpl
is accurate/should be updated