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

Add RecordVideo docs #2332

Merged
merged 2 commits into from
Aug 23, 2021
Merged

Add RecordVideo docs #2332

merged 2 commits into from
Aug 23, 2021

Conversation

vwxyzjn
Copy link
Contributor

@vwxyzjn vwxyzjn commented Aug 18, 2021

No description provided.

@jkterry1
Copy link
Collaborator

Hey, we're trying to go more for the homogenous style of showing the function, including a blurb and listing what each argument does than having examples for each method. Would you mind restructuring this a little for that structure?

@vwxyzjn
Copy link
Contributor Author

vwxyzjn commented Aug 18, 2021

This is also related to #2327. @tristandeleu seems to have used RSTs for the documentation probably for auto documentation generation via Sphinx. Is there an instruction for building documentation via Sphinx?

@vwxyzjn
Copy link
Contributor Author

vwxyzjn commented Aug 18, 2021

@jkterry1 do you have an example?

@jkterry1
Copy link
Collaborator

We aren't going to be doing documentation remotely resembling how tristan did his and I didn't get a chance to reply to his PR yet (#2276). Filling out the file as is going to be the best way to add docs; during the final merge Kyle will cleanup any problems that exist.

@jkterry1
Copy link
Collaborator

I'll deal with this as the website is closer to being released

@jkterry1
Copy link
Collaborator

I'm merging this now and I'll go through and fix style things myself when I do the big docs refactor, god willing in a couple of weeks.

@jkterry1 jkterry1 merged commit 6052616 into openai:master Aug 23, 2021
zlig pushed a commit to zlig/gym that referenced this pull request Sep 6, 2021
* add `RecordVideo` docs

* add deprecation notice
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

Successfully merging this pull request may close these issues.

None yet

2 participants