search

regl-project / regl

👑 Functional WebGL
https://regl-project.github.io/
MIT License
5.21k stars 322 forks source link

Possible documentation bug: description of "props" cuts off mid sentence #495

Open nathanielvirgo opened 6 years ago

nathanielvirgo commented 6 years ago

At http://regl.party/api, the documentation for props looks like this:

The most common way to pass data into regl is via props. The props for a render command are declared

That's the whole thing! I'm wondering if the text is actually written somewhere and failing to be displayed for some reason. (It seems like quite an important concept.)

rreusser commented 6 years ago

Hmm… maybe outdated on regl.party? Looks like this section, I think. That should be in sync, but when in doubt, the repo probably has the most up-to-date version.

nathanielvirgo commented 6 years ago

Ah, that's much better.

Just to note: if I go to the project page at https://github.com/regl-project/regl and click on "Docs", it links to https://github.com/regl-project/regl/blob/gh-pages/API.md#props , which has the same text as on regl.party. The existence of the separate documentation page you linked to was not obvious to me!

On 17 June 2018 at 16:21, Ricky Reusser notifications@github.com wrote:

Hmm… maybe outdated on regl.party? Looks like this section https://github.com/regl-project/regl/blob/master/API.md#props, I think. That should be in sync, but when in doubt, the repo probably has the most up-to-date version.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/regl-project/regl/issues/495#issuecomment-397859895, or mute the thread https://github.com/notifications/unsubscribe-auth/AGpFxPLhFPU73yHb6xjk0Gqojx345C30ks5t9gNsgaJpZM4UqvIH .

-- Nathaniel Virgo http://nathanielvirgo.com