-
Notifications
You must be signed in to change notification settings - Fork 286
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
chore: following semantic line breaks in documentations #2123
Comments
I'm onboard with adopting semantic line breaks. |
Seems good, would need to see an example in our case, I'm not quite sure what this looks like in practice. |
I have applied the semantic break-line rule in this PR for a sample. |
I'm down SGTM |
It seems easier to read, I am in |
How do we close this issue? It seems monumental to revisit every document in this repo and apply this rule. Should we only apply it for new docs? |
Initially, I think that would be sufficient to ensure that new documents adhere to semantic line breaks. cc: @evan-forbes @rootulp please let me know what you think about this, then I'l proceed accordingly. |
If anyone has different opinions about how to proceed with this issue, feel free to share. |
SGTM |
Problem
The following issue is more of a suggestion than a problem.
I'd like to recommend incorporating semantic line breaks into our documentation. The concept involves strategically placing line breaks at semantic boundaries. In markup languages like Markdown, single line breaks are typically invisible to readers, however, it offers several advantages to the authors and editors, as highlighted in the link provided:
Proposal
Once/If the decision to implement semantic line breaks is finalized, we can update the relevant section to reflect this choice and effectively communicate it with the team.
The text was updated successfully, but these errors were encountered: