search

brownplt / pyret-docs

The documentation for Pyret.
9 stars 18 forks source link

Stacked Bar Chart Documentation #63

Closed JohnUUU closed 2 years ago

JohnUUU commented 2 years ago
jpolitz commented 2 years ago

@blerner and I noticed that most of the xrefs can be expressed as pyret-id or pyret-method.

See https://github.com/brownplt/pyret-docs/blob/111f43564ff3410775a93327c425faf23ae103ba/scribble-api.rkt#L276

JohnUUU commented 2 years ago

I'll make sure to go into the documentation and replace it wherever I can by the end of tomorrow since I'll be a little bit busy today!

JohnUUU commented 2 years ago

Hey, I'm currently working on a final pass through the documentation and trying to replace xref with pyret-id and pyret-method wherever applicable. I'm just struggling a bit with figuring out how to use pyret-id in the method-doc section since all the examples I can find are all in the form

@pyret-method[datatype, varname, id]

Trying to translate that to the method-doc environment like this

,(pyret-method datatype varname id)

seemingly always leads to a contract violation. Sorry if the solution is obvious, I just can't seem to figure out how to translate it.

jpolitz commented 2 years ago

Sorry for the botched merge. Which methods are in this docs merge but not in the smaller SBC commit? We can't have things documented that aren't implemented, which is why I reverted. https://github.com/brownplt/code.pyret.org/pull/421

JohnUUU commented 2 years ago

Yeah sorry about that I guess I forgot to pull out a separate documentation to match the smaller PR. It's a bit more complicated than simply rolling back since I implemented and documented different sections at different times, but I'll work on getting a seperate documentation branch out when I have the time to do so! Thank you for bringing this to my attention!