Skip to content

Change comments for improved consistency #5223

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
Merged
merged 2 commits into from
Oct 11, 2021
Merged

Change comments for improved consistency #5223

merged 2 commits into from
Oct 11, 2021

Conversation

NumberPiOso
Copy link
Contributor

Python/CONTRIBUTING.md

Line 56 in 729b4d8

python3 -m pip install pre-commit # required only once

Python/CONTRIBUTING.md

Line 80 in 729b4d8

python3 -m pip install black # only required the first time

Python/CONTRIBUTING.md

Line 87 in 729b4d8

python3 -m pip install flake8 # only required the first time

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.
  • [ X 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 Oct 11, 2021
@ghost ghost removed the awaiting reviews This PR is ready to be reviewed label Oct 11, 2021
@poyea poyea merged commit 9586a6a into TheAlgorithms:master Oct 11, 2021
shermanhui pushed a commit to shermanhui/Python that referenced this pull request Oct 22, 2021
@NumberPiOso @shermanhui
Change comments for improved consistency (TheAlgorithms#5223)
8816700 
* Change comments for improved consistency

https://github.com/TheAlgorithms/Python/blob/master/CONTRIBUTING.md#L56
https://github.com/TheAlgorithms/Python/blob/master/CONTRIBUTING.md#L80
https://github.com/TheAlgorithms/Python/blob/master/CONTRIBUTING.md#L87

* updating DIRECTORY.md

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@poyea poyea poyea approved these changes

Assignees
No one assigned
Labels
documentation This PR modified documentation files
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@NumberPiOso @poyea