regl icon indicating copy to clipboard operation
regl copied to clipboard

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

Open nathanielvirgo opened this issue 6 years ago • 2 comments

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.)

nathanielvirgo avatar Jun 17 '18 07:06 nathanielvirgo

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.

rreusser avatar Jun 17 '18 07:06 rreusser

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 [email protected] 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

nathanielvirgo avatar Jun 17 '18 10:06 nathanielvirgo