Remove unnecessary spaces in README for a more compact view #20
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.
Description
This pull request addresses issue #19 by improving the readability and compactness of the README file. The changes focus on removing unnecessary spaces and optimizing the template used to generate the README content. These modifications will result in a cleaner, more compact layout that is easier to read and scan.
Key changes include:
The impact of these changes will be:
Testing has been performed by running the
update_views.py
script locally and verifying the output README file. The changes have been confirmed to maintain the correct structure and content while reducing unnecessary whitespace.Changes
.github/scripts/update_views.py
:import re
to use regular expressions for newline removalstrip()
function to remove leading/trailing whitespace from final content.github/templates/readme_template.md
:-
) to Jinja2 tags to control whitespace outputDocumentation
No additional documentation updates are required for this change, as it primarily affects the README file itself, which is the main documentation for the project.
Closes #19