add clear comments and improve readability in HTMLProofer script #3555
Conversation
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
This commit adds detailed documentation comments and improves the formatting of the HTMLProofer runner script to enhance readability and make the code easier for new contributors to understand. Key improvements: - Added explanatory comments for script purpose and each configuration option - Added section headers to structure the file - Documented URL ignore list and regex patterns - Improved spacing and formatting for clarity - Added `frozen_string_literal: true` for Ruby best practices No functional behavior was changed; the script runs exactly as before. These updates strictly improve maintainability and contributor experience.
Maruti1887
temporarily deployed
to
Pages Preview
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This commit adds detailed documentation comments and improves the formatting of the HTMLProofer runner script to enhance readability and make the code easier for new contributors to understand.
Key improvements:
frozen_string_literal: truefor Ruby best practicesNo functional behavior was changed; the script runs exactly as before. These updates strictly improve maintainability and contributor experience.