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

Simplify authors and copyright in all .py files (and make consistent) #1267

Merged
merged 10 commits into from
Jul 11, 2024

Conversation

sappelhoff
Copy link
Member

PR Description

Merge checklist

Maintainer, please confirm the following before merging.
If applicable:

  • All comments are resolved
  • This is not your own PR
  • All CIs are happy
  • PR title starts with [MRG]
  • whats_new.rst is updated
  • New contributors have been added to CITATION.cff
  • PR description includes phrase "closes <#issue-number>"

@@ -53,3 +54,6 @@
subject="01", session="mysession", datatype="meg", root="path/to/project"
).mkdir()
print(bids_path.directory)

# clean up
shutil.rmtree(bids_path)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this would otherwise create an annoying directory when running tests locally

@@ -204,7 +204,7 @@ jobs:
- name: Install MNE (previous stable)
if: matrix.mne-version == 'mne-prev-stable'
run: |
git clone --single-branch --branch maint/1.5 https://github.com/mne-tools/mne-python.git
git clone --single-branch --branch maint/1.6 https://github.com/mne-tools/mne-python.git
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why did we opt to not get this from PyPI?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need the full repo, including stuff that's not shipped in the dist

@@ -6,6 +6,10 @@
https://doughellmann.com/blog/2010/05/09/defining-custom-roles-in-sphinx/

"""

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't this go to the very very top of every file?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should go right below the module docstrings 🤔 that's how it's in sklearn, too, see: https://github.com/scikit-learn/scikit-learn/blob/main/sklearn/decomposition/_base.py

Copy link
Member

@hoechenberger hoechenberger Jul 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok then! i still find it odd, i thought its supposed to be a header 😅

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The guideline says "near the beginning" (https://www.bestpractices.dev/en/projects/7783?criteria_level=2)

The project MUST include a license statement in each source file. This MAY be done by including the following inside a comment near the beginning of each file:

:-)

I am going ahead and will merge this now. We can always change it later. Thanks!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes all good! thanks for the work!!!

@sappelhoff sappelhoff merged commit 313fe10 into mne-tools:main Jul 11, 2024
20 checks passed
@sappelhoff sappelhoff deleted the copyright branch July 11, 2024 16:47
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

Successfully merging this pull request may close these issues.

Add copyright holder to each file, and remove individual authors
3 participants