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.

Sign up for GitHub

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

Jump to bottom

[MNT] Set author names in files to GitHub names #4335

Closed
SamiAlavi opened this issue Mar 15, 2023 · 1 comment · Fixed by #4340
Closed

[MNT] Set author names in files to GitHub names #4335

SamiAlavi opened this issue Mar 15, 2023 · 1 comment · Fixed by #4340
Labels
documentation Documentation & tutorials good first issue Good for newcomers

Comments

@SamiAlavi
Copy link
Contributor

The official style guide PEP 8 provides an example with only one author. However, web archive's page Python Coding Guidelines 12/14/07 lists multiple authors as comma separated values in author with type str.

We can also list authors like this

sktime/extension_templates/forecasting.py

Lines 45 to 46 in 2544272

# todo: uncomment the following line, enter authors' GitHub IDs
# __author__ = [authorGitHubID, anotherAuthorGitHubID]

@SamiAlavi SamiAlavi added the documentation Documentation & tutorials label Mar 15, 2023
@SamiAlavi SamiAlavi mentioned this issue Mar 15, 2023
Merged
5 tasks
@fkiraly fkiraly added the good first issue Good for newcomers label Mar 15, 2023
@SamiAlavi
Copy link
Contributor Author

A previous PR #3628 already fixed most of the naming issues.

@SamiAlavi SamiAlavi mentioned this issue Mar 15, 2023
Merged
5 tasks
fkiraly pushed a commit that referenced this issue Mar 22, 2023
@SamiAlavi
[MNT] replace author names by GitHub ID in author fields (#4340)
19500a7 
Fixes #4335

- `__author__` names to their GitHub IDs
- `__author__` type `str` to `List[str]` for consistency
- use `__author__` instead of `__authors__`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Documentation & tutorials good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[MNT] replace author names by GitHub ID in author fields SamiAlavi/sktime
2 participants
@fkiraly @SamiAlavi