Skip to content

Fixes #4712 #4797

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
Closed
wants to merge 1 commit into from
Closed

Fixes #4712 #4797

wants to merge 1 commit into from

Conversation

joesinghh
Copy link
Contributor

Describe your change:

  • 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}.

@ghost ghost added awaiting reviews This PR is ready to be reviewed documentation This PR modified documentation files labels Sep 30, 2021
@cclauss
Copy link
Member

cclauss commented Sep 30, 2021 •
edited
Loading

Fixes #4712 is a really poor title for a pull request because it forces the reviewer to type by hand the issue that is being fixed. Instead, the title should briefly describe the issue being fixed and the commit message should contain Fixes #4712 which

  1. Gives the reviewer an easy link to click on to read the issue, and
  2. Allows GitHub to autoclose the issue when the pull request is landed.

@joesinghh
Copy link
Contributor Author

Fixes #4712 is a really poor title for a pull request because it forces the reviewer to type by hand the issue that is being fixed. Instead, the title should briefly describe the issue being fixed and the commit message should contain Fixes #4712 which

  1. Gives the reviewer an easy link to click on to read the issues, and
  2. Allows GitHub to autoclose the issue when the pull request is landed.

okay got it, thanks for mentioning it.

cclauss
cclauss reviewed Sep 30, 2021
View reviewed changes
.github/pull_request_template.md
@@ -14,7 +14,8 @@
* [ ] 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](https://docs.python.org/3/library/typing.html).
* [ ] All function parameters and return values are annotated with Python [mypy](https://docs.python.org/3/library/typing.html).
Copy link
Member

Choose a reason for hiding this comment

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

Please undo. These are type hints. Mypy and Pyright are both programs that test type hints.

.github/pull_request_template.md
* [ ] All functions have [doctests](https://docs.python.org/3/library/doctest.html) that pass the automated testing.
* [ ] All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
* [ ] Modified/Added code follows [black](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html) and [flake8](https://flake8.pycqa.org/en/latest/) code style.
Copy link
Member

@cclauss cclauss Sep 30, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

We have automated tests for this so we do not need to ask the contributor if they have done this.

@cclauss cclauss closed this Sep 30, 2021
@joesinghh joesinghh deleted the patch-1 branch September 30, 2021 16:13
@cclauss cclauss mentioned this pull request Sep 30, 2021
Closed
@cclauss cclauss mentioned this pull request Oct 2, 2022
Merged
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss cclauss left review comments

@dhruvmanila dhruvmanila Awaiting requested review from dhruvmanila

Assignees
No one assigned
Labels
awaiting reviews This PR is ready to be reviewed documentation This PR modified documentation files
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@joesinghh @cclauss