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

[Docs] Explicit link to API? #2013

Closed
EricCousineau-TRI opened this issue Aug 4, 2020 · 2 comments
Closed

[Docs] Explicit link to API? #2013

EricCousineau-TRI opened this issue Aug 4, 2020 · 2 comments

Comments

@EricCousineau-TRI
Copy link

For the website's docs: http://gym.openai.com/docs/

When I see docs for a website, I'd expect an explicit link to the API documentation too.
The API is explained in that section, but it'd be nice to get the full story without having to infer.

There's an implicit link to the API here:

image

I think this would be 1000% better if it said "(click here for API)", or even a section that said "API Documentation", and then said "Here, go look at the gym/core.py."

I'd submit a PR, but with #2012, I dunno where to submit it...

@EricCousineau-TRI
Copy link
Author

Just to throw in some more rando comment, one thing that got me to is that both unlinked and linked preformatted text are the same color, so it's hard to tell what's a link:

image

In this pic, observation_space is just text, whereas Space is not.

(That being said, thanks for the great work! It's super nice to leverage this library!)

@jkterry1
Copy link
Collaborator

closed in favor of issue #2276

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants