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

episodes/*md: implement semantic line breaks #22

Open
wants to merge 20 commits into
base: main
Choose a base branch
from

Conversation

wmotion
Copy link
Contributor

@wmotion wmotion commented Nov 26, 2024

Objective: each document line contains a single sentence finishing with full stop, question or exclamation marks. This helps maintain the code using git diffs.

wmotion added 20 commits June 30, 2023 16:41
benchmarking.md: readability pass 1
computing-pi.md: readability pass 1
threads-and-processes.md: readability pass 1
Plus a few minor edits, which will show up when merging with other branches,
Plus fix punctuation, which may show again up when merging back into other branches
I am resuming this merge after a very long break.
The changes accepted are:
* in most cases, one-line paragraphs are split in as many paragraphs as there are lines
* in some cases, a sentence was split across line and has been merged into one
* in a few case, I have edited for readability (half an error because there is a branch for it!)

So be it
Sentences ending with full stop, exclamation marks and question marks are single lines.
Done manually to stay on the side of caution: outcome prone to misses
Copy link

🆗 Pre-flight checks passed 😃

This pull request has been checked and contains no modified workflow files or spoofing.

Results of any additional workflows will appear here when they are done.

@jhidding
Copy link
Collaborator

Hi Giordano, it's very nice that you want to do this, but we're also currently improving the material in some other places. This will for sure introduce some major merge conflicts. I'll have to wait merging this for the moment. Please contact me before doing too much work!

@wmotion
Copy link
Contributor Author

wmotion commented Nov 26, 2024

Hi Giordano, it's very nice that you want to do this, but we're also currently improving the material in some other places. This will for sure introduce some major merge conflicts. I'll have to wait merging this for the moment. Please contact me before doing too much work!

@jhidding It's for free. It made my own fork cleaner and more consistent. So merge it when you see it fit. I have no schedule attached to this PR.

Semantic line breaks make merges easier, by the way. It might be an idea that you implement those in your edits. Happy work!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants