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

Consider introducing line breaks after each sentence #1

Open
cygnusv opened this issue Sep 26, 2024 · 0 comments
Open

Consider introducing line breaks after each sentence #1

cygnusv opened this issue Sep 26, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@cygnusv
Copy link
Member

cygnusv commented Sep 26, 2024

Single line breaks are ignored by Markdown, so they're effectively equivalent to spaces. However, this has the advantage that future changes are more surgical, since often changes only affect a single sentence (or perhaps, the sentences just above or below), which facilitates reviews a lot. Currently, most lines in the docs contain full paragraphs, so a single letter change in a paragraph is rendered by diff viewers as affecting the complete paragraph.

We can do this iteratively, so eventually all the code follows the same convention.

@cygnusv cygnusv added the enhancement New feature or request label Sep 26, 2024
cygnusv added a commit that referenced this issue Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant