brownplt / pyret-docs

The documentation for Pyret.
9 stars 18 forks source link

Searching for `include` in docs doesn't find anything #55

Closed jbclements closed 4 years ago

jbclements commented 4 years ago

First off, please feel free to close this issue; I'm partly just interested to know if this is the right way to report things like this, or if things like this should be reported at all.

I've just spent a happy half-hour running through some of the first assignments from csci0111, and in assignment 2 I can't use the link because I don't have a brown gmail address, no problem but I have to figure out how to import the list functions myself. Assignment 1 uses the form "include image" to import the image library.

Trying to use "include lists" fails with a giant list of "please don't re-import " errors. I went looking for "include" in the docs, and I'm pretty sure it's not there at all. I do see the docs for "import", which give me everything I need, but it looks like "include" is undocumented.

Steps to reproduce:

1) visit this URL: https://www.pyret.org/docs/latest/Glossary.html?q=include

blerner commented 4 years ago

At the moment, include indeed isn't documented, mostly because of that cascading pile of errors you get. We're in the (very extended) process of revamping Pyret's module system, such that (a) those re-import errors wouldn't happen any more, and (b) there's a finer control over importing and exporting values from modules. It's similar to, but not as elaborate as, Racket's system of requires and provides. Once that module system (finally!) lands, the documentation for include will go live as well. It's been written :) See https://github.com/brownplt/pyret-docs/blob/horizon/src/lang/modules.scrbl for the un-rendered sources at the moment. That said, I just tried searching for include in those docs, and the search doesn't find it. There's still some more cleanup to be done on section 2.1.4 ("Import statements") to properly link over to the this modules page, and some more elaboration to make it more complete.

sorawee commented 4 years ago

Here's a rendered version: https://www.pyret.org/docs/horizon/modules.html

jbclements commented 4 years ago

Okay, sounds good! Feel free to close this issue if you like.