Skip to content

Conversation

@drts01
Copy link
Contributor

@drts01 drts01 commented Oct 6, 2020

Describe your change:

  • clean up docstrs
  • add type hints
  • improve coding-style
     
  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

Part of Issues: #2786, #2510

@dhruvmanila
Copy link
Member

Due to #2891, this becomes unnecessary. Thanks for your contribution!

@dhruvmanila dhruvmanila closed this Oct 6, 2020
@drts01
Copy link
Contributor Author

drts01 commented Oct 6, 2020

@dhruvmanila the type hints was just one commit. the code clean up in the other 4 commits are not desired? FYI, I dropped the type hints commit and rebased off of master if you want reopen and merge these change.

@dhruvmanila
Copy link
Member

Sure thing, remove the type hints commit and it will be good to go.
Also, why are you disabling flake8?

I cannot reopen as you rebased it.

@drts01
Copy link
Contributor Author

drts01 commented Oct 6, 2020

will create a new PR. that noqa was a mistake 🤦

@drts01 drts01 mentioned this pull request Oct 6, 2020
14 tasks
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.

3 participants