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

Remove unnecessary spaces in README for a more compact view #20

Merged
merged 1 commit into from
Sep 30, 2024

Conversation

thibaultyou
Copy link
Owner

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:

  • Removing extra newlines in the generated README content
  • Optimizing the Jinja2 template to reduce unnecessary whitespace
  • Stripping leading and trailing whitespace from the final README content

The impact of these changes will be:

  • Improved readability of the README file
  • More efficient use of screen space
  • Better overall user experience for project visitors and contributors

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

  1. .github/scripts/update_views.py:

    • Added import re to use regular expressions for newline removal
    • Implemented regex to remove multiple consecutive newlines
    • Added strip() function to remove leading/trailing whitespace from final content
  2. .github/templates/readme_template.md:

    • Removed unnecessary newlines between Jinja2 template tags
    • Added hyphen (-) to Jinja2 tags to control whitespace output

Documentation

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

@thibaultyou thibaultyou merged commit 30f2c32 into main Sep 30, 2024
1 check passed
@thibaultyou thibaultyou self-assigned this Sep 30, 2024
@thibaultyou thibaultyou added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 30, 2024
@thibaultyou thibaultyou deleted the refactor/19-compact-readme-generation branch September 30, 2024 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove unnecessary spaces in README for a more compact view
1 participant