Reformat RST files for better diffs#431
Merged
Merged
Conversation
cmelone
reviewed
Jun 2, 2025
* Update basics section * Fix typos and suggestions for binary cache * Fix typos and add suggestions to buildsystems
haampie
approved these changes
Jun 3, 2025
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
3 participants
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.
@haampie pointed out that diffs can be quite painful to review since we have sentences stretched out over multiple lines. This PR implements a simple program to reformat the RST files into a standardized one sentence per line of unlimited length. We also add a CI/CD check to continually enforce this formatting on the repository for easier maintenance.