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

Fix a few typos in the docs #2573

Merged
merged 6 commits into from Feb 16, 2024
Merged

Fix a few typos in the docs #2573

merged 6 commits into from Feb 16, 2024

Conversation

kraasch
Copy link
Contributor

@kraasch kraasch commented Feb 14, 2024

No description provided.



Learning Modern 3D Graphics Programming
---------------------------------------

This `book <https://paroj.github.io/gltut/>`_ is intended to teach you how
`This book <https://paroj.github.io/gltut/>`_ is intended to teach you how
Copy link
Member

Choose a reason for hiding this comment

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

Is there a reason for this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Seems a bit ugly to me to split the noun phrase. In this sense, 'book' could just be any book, the link could be even point to Wikipedia, the reader doesn't know.

The actual faux pas here is to conceal the name of the book.

Copy link
Member

Choose a reason for hiding this comment

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

Good point! Do you want to put the real name of the online book there instead?

doc/getting_started/modern-gl.rst Show resolved Hide resolved
@djhoese djhoese changed the title Fixed a few typos in the docs. Fix a few typos in the docs Feb 14, 2024
@djhoese djhoese self-assigned this Feb 14, 2024
Copy link
Member

@djhoese djhoese left a comment

Choose a reason for hiding this comment

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

Nice job. Thanks for fixing these things.

@djhoese djhoese merged commit 512a1ce into vispy:main Feb 16, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants