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

[DOC] Remove optional from docstrings #1451

Closed
TonyBagnall opened this issue Apr 22, 2024 · 1 comment · Fixed by #1458
Closed

[DOC] Remove optional from docstrings #1451

TonyBagnall opened this issue Apr 22, 2024 · 1 comment · Fixed by #1458
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@TonyBagnall
Copy link
Contributor

Describe the issue linked to the documentation

this is a minor change to allow new contributors to figure out the github workflow and make a first minor contribution. Our current standard doc comment for optional parameters is the

   window_length : int, default=10

however, in many places it is still listed as this

   window_length : int, optional (default=10)

it would be good to standardise across the toolkit. Feel free to change as few or as many as these as you want in order to make a contribution

Suggest a potential alternative/fix

No response

@TonyBagnall TonyBagnall added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 22, 2024
@griegner
Copy link
Contributor

Happy to take on this issue, using vscode's find/replace to find regex pattern optional \(default=(.*)\) and replace with default=$1. I'll double check all replacements to verify that this procedure doesn't cause any problems with edge cases.

griegner added a commit to griegner/aeon that referenced this issue Apr 22, 2024
* find `optional \(default=(.*)\)`, replace with `default=$1`
* review all changes
TonyBagnall pushed a commit that referenced this issue Apr 23, 2024
* [DOC] Remove optional from docstrings (#1451)
* find `optional \(default=(.*)\)`, replace with `default=$1`
* review all changes

* add my contribution
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants