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
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/getting_started/modern-gl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ scene such that all objects are withing this direction but it would not be very
convenient. So instead, we'll use a view matrix that will map the the world
space to camera space. This is pretty much as if we were orienting the camera
at a given position and look toward a given direction. In the meantime, we can
further refine the whole pipeline by providing a model matrix that will maps
further refine the whole pipeline by providing a model matrix that will map
the object's local coordinate space into world space. For example, this will be
useful for rotating an object around its center. To sum up, we need:

Expand All @@ -273,18 +273,18 @@ and not the fixed one.
An intro to modern OpenGL
-------------------------

OpenGL has been around a long time, and from reading all the accumulated layers
OpenGL has been around a long time and from reading all the accumulated layers
djhoese marked this conversation as resolved.
Show resolved Hide resolved
of documentation out there on the Internet, it's not always clear what parts
are historic and what parts are still useful and supported on modern graphics
hardware. It's about time for a new OpenGL `introduction that
hardware. It's about time for a `new OpenGL introduction
<http://duriansoftware.com/joe/An-intro-to-modern-OpenGL.-Table-of-Contents.html>`_
walks through the parts that are still relevant today.
that walks through the parts that are still relevant today.


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?

to be a graphics programmer. It is not aimed at any particular graphics field;
it is designed to cover most of the basics of 3D rendering. So if you want to
be a game developer, a CAD program designer, do some computer visualization, or
Expand All @@ -301,5 +301,5 @@ OpenGL ES 2.0 documentation
the OpenGL 2.0 specification and emphasizes a programmable 3D graphics pipeline
with the ability to create shader and program objects and the ability to write
vertex and fragment shaders in the OpenGL ES Shading Language. VisPy is based
on OpenGL ES 2.0 because it give access to the programmable pipeline while
on OpenGL ES 2.0 because it gives access to the programmable pipeline while
keeping overall complexity tractable.