Improve comments, add doctests for kahns_algorithm_topo.py#11668
Merged
tianyizheng02 merged 4 commits intoTheAlgorithms:masterfrom Oct 4, 2024
Merged
Improve comments, add doctests for kahns_algorithm_topo.py#11668tianyizheng02 merged 4 commits intoTheAlgorithms:masterfrom
tianyizheng02 merged 4 commits intoTheAlgorithms:masterfrom
Conversation
for more information, see https://pre-commit.ci
15 tasks
tianyizheng02
requested changes
Oct 2, 2024
tianyizheng02
approved these changes
Oct 4, 2024
Contributor
tianyizheng02
left a comment
There was a problem hiding this comment.
LGTM, thanks for your contribution!
Contributor
Author
|
Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
Checklist: