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

Spelling and grammar fixes. #24

Merged
merged 2 commits into from
Mar 6, 2025
Merged

Spelling and grammar fixes. #24

merged 2 commits into from
Mar 6, 2025

Conversation

kratz00
Copy link

@kratz00 kratz00 commented Mar 4, 2025

A couple of:

  • spelling fixes
  • grammar fixes
  • formatting fixes

@schlimmchen
Copy link
Member

Very nice, thank you!

There are two kinds of changes that I won't merge:

  1. Changing iterations (numbered lists) to use incrementing indices in the source. This is not required as mkdocs/markdown knows that this is an iteration and that each new item must use a new index. Trying to use incrementing indices in the source is a problem, because one needs to update the whole list every time a new item is inserted in between existing items. That's why I just use "1." on every item in an iteration.
  2. I don't want to format tables neatly in the source. Similarly to numbered lists, changing the table (like columns width because of one column enlarges) then prompts huge changesets, as the whole table needs to be reformatted. That is to be avoided. Also, I want to keep compatibility with the upstream version of the same table, so merging upstream changes isn't a PITA every time it is attempted.

Signed-off-by: Steffen Pankratz <[email protected]>
@schlimmchen schlimmchen merged commit 2860d05 into hoylabs:main Mar 6, 2025
@kratz00 kratz00 deleted the typos branch March 6, 2025 20:04
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