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 for kahns_algorithm_topo.py #11668

Merged

Conversation

Hardvan
Copy link
Contributor

@Hardvan Hardvan commented Oct 2, 2024

The improvements to the code include adding a more detailed docstring that explains the purpose, parameters, return values, and the use of Kahn's Algorithm for topological sorting. The docstring now includes doctests, providing example usage and handling edge cases such as graphs with cycles. Inline comments clarify key steps like indegree calculation, queue initialization, and the BFS process. Additionally, explicit handling and explanation of cycle detection were added, making the code more readable and understandable while ensuring that it is easy to validate using the provided test cases.

  • 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 Oct 2, 2024
@Hardvan Hardvan requested a review from tianyizheng02 October 3, 2024 03:54
Copy link
Contributor

@tianyizheng02 tianyizheng02 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for your contribution!

@tianyizheng02 tianyizheng02 merged commit e20b503 into TheAlgorithms:master Oct 4, 2024
3 checks passed
@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 4, 2024
@Hardvan
Copy link
Contributor Author

Hardvan commented Oct 4, 2024

Thanks!

@isidroas isidroas mentioned this pull request Jan 25, 2025
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This PR modified some existing files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants