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

Lots of grammar/spelling issues & rewrote some docs #119

Merged
merged 2 commits into from
May 6, 2022

Conversation

spnda
Copy link
Member

@spnda spnda commented May 5, 2022

I found a lot of grammar and spelling issues throughout the first chapter (1-1-getting-started). Some changes are just sentences I reworded because they didn't sound good at all. I also rewrote index.md and 1-1-0-overview.md with better language and more content, hopefully appealing more to new readers and beginners. I also tried to enforce a 100 line column limit in some files so that the markdown text is easier to read and write, as there are a few occurrences of 300 to 500 long lines and it is nearly impossible to read them on GitHub or an editor that doesn't have line break enabled by default.
Partial fix to #42.

@spnda spnda added the documentation Improvements or additions to documentation label May 5, 2022
@spnda spnda requested a review from deccer May 5, 2022 20:06
Copy link
Contributor

@deccer deccer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just minor things mostly spaces

about odd fractionals to manually scale the windowsize for any arbitrary scaling on your OS.
This will tell `GLFW` to not scale the window in any way, should you have set up a specific scaling
other than 100% on your desktop. That will keep the window size at what we set it, without thinking
about odd fractional to manually scale the window size for any arbitrary scaling on your OS.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm, isn't the right word fractions?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've changed it to , and lets us forget about fractional window and pixel scaling.. I think that's more understandable than what we currently have.

Copy link
Contributor

@deccer deccer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@deccer deccer merged commit 5a71df4 into GraphicsProgramming:main May 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants