Added docstrings to improve documentation in sort_blocks and in main function and also add another exception handeled. #2653
Conversation
This file contains 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
…function and also handeled the exception in the main block
|
ัุุุ |
|
y |
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.
…function and also handeled the exception in the main block
What is this Python project?
-> This python project automates "Readme File Organization " by sorting sections while keeping the headers intact.
-> It helps to maintain the consistency in the documentation and also it is very useful for large repositories.
Describe features.
What's the difference between this Python project and similar ones?
-> Unlike traditional README generators, this project does not create a README from scratch but rather sorts and organizes an existing one.
-> Many similar tools focus on generating documentation from code comments, whereas this script helps restructure and clean up an existing README.md.
-> This project maintains the hierarchical structure of headers and sections while ensuring that the entries under each section are sorted properly.
-> It automatically detects list entries (e.g., links in bullet points) and sorts them while preserving indentation.
-> The newly added exception handling makes it more robust compared to scripts that assume the README is always formatted correctly.
Enumerate comparisons.
What's the Difference Between This Python Project and Similar Ones?
| Feature | This Project | Similar Projects |
| README Organization | Sorts and restructures an existing README. | Many tools generate a new README from scratch. |
| Section Headers Handling | Preserves and maintains section headers. | Some tools may overwrite or remove headers. |
| Sorting Method | Sorts list entries within sections while keeping structure intact. | Often sorts the entire document without maintaining hierarchy. |
| Exception Handling | Includes error handling to prevent script failures. | Some scripts assume perfect input and may crash on errors. |
| Indentation Preservation | Maintains proper indentation while sorting. | Other tools may ignore formatting consistency. |
--
Anyone who agrees with this pull request could submit an Approve review to it.