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

Improve comments, add doctests to coloring.py #11589

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

Hardvan
Copy link
Contributor

@Hardvan Hardvan commented Sep 30, 2024

Added more comprehensive comments and more doctests to each function present in coloring.py.

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • 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 include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@algorithms-keeper algorithms-keeper bot added enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed labels Sep 30, 2024
@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Sep 30, 2024
@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Sep 30, 2024
@algorithms-keeper algorithms-keeper bot mentioned this pull request Sep 30, 2024
15 tasks
Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

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

Keep comments short to not slow down the reader.

The ruff rules D can be quite useful.

Hardvan and others added 2 commits October 1, 2024 08:21
Co-authored-by: Christian Clauss <[email protected]>
Co-authored-by: Christian Clauss <[email protected]>
@github-actions github-actions bot force-pushed the coloring-improvement branch from 38d0560 to 9da28b0 Compare October 1, 2024 02:52
Co-authored-by: Christian Clauss <[email protected]>
@github-actions github-actions bot force-pushed the coloring-improvement branch from 42c32e7 to 38d0560 Compare October 1, 2024 02:52
Co-authored-by: Christian Clauss <[email protected]>
@github-actions github-actions bot force-pushed the coloring-improvement branch from 38d0560 to 42c32e7 Compare October 1, 2024 02:52
Co-authored-by: Christian Clauss <[email protected]>
@github-actions github-actions bot force-pushed the coloring-improvement branch from 26321da to 7fafb02 Compare October 1, 2024 02:52
@Hardvan
Copy link
Contributor Author

Hardvan commented Oct 1, 2024

Keep comments short to not slow down the reader.

The ruff rules D can be quite useful.

I have committed the suggested comment changes and marked the changes as resolved.

@cclauss
Copy link
Member

cclauss commented Oct 1, 2024

Please remove the duplicate type hints in comments so the following command passes without errors.
% ruff check --select=D417 backtracking/coloring.py

@Hardvan
Copy link
Contributor Author

Hardvan commented Oct 1, 2024

Please remove the duplicate type hints in comments so the following command passes without errors. % ruff check --select=D417 backtracking/coloring.py

I'm sorry for missing this! I have removed the argument type hints in the function docstring.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants