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.

Sign up for GitHub

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

Jump to bottom

Updated Wrapper docs #173

Merged
merged 2 commits into from
Dec 3, 2022
Merged

Updated Wrapper docs #173

merged 2 commits into from
Dec 3, 2022

Conversation

Markus28
Copy link
Contributor

@Markus28 Markus28 commented Dec 2, 2022

  • Some descriptions of what wrappers do was moved from doctoring of superclass to module docstring
  • Examples of wrapper implementations were moved from docstrings to a tutorial
  • Removed the titles for each individual wrapper in the docs

@Markus28
Moved examples from docstrings to tutorials, removed some headings, m…
e372e10 
…oved some stuff from docstring of wrapper superclass to module docstring
@Markus28 Markus28 marked this pull request as ready for review December 2, 2022 17:20
pseudo-rnd-thoughts
pseudo-rnd-thoughts approved these changes Dec 3, 2022
View reviewed changes
Copy link
Member

@pseudo-rnd-thoughts pseudo-rnd-thoughts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there any links between the tutorials and api docs

@Markus28
Copy link
Contributor Author

Markus28 commented Dec 3, 2022

Not yet, but I can add one from the tutorial to the docs :)
Should we also do one from the module doctoring to the tutorial? That would need to be an absolute URL then, right?

@pseudo-rnd-thoughts
Copy link
Member

I believe that sphinx allows both relative and absolution links

@Markus28
Copy link
Contributor Author

Markus28 commented Dec 3, 2022

Done :)

@pseudo-rnd-thoughts pseudo-rnd-thoughts merged commit 851b2f4 into Farama-Foundation:main Dec 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pseudo-rnd-thoughts pseudo-rnd-thoughts pseudo-rnd-thoughts approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Markus28 @pseudo-rnd-thoughts