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

Incorrect/incomplete docstring in environment.py #560

Closed
chasgior214 opened this issue Feb 21, 2024 · 4 comments · Fixed by #565
Closed

Incorrect/incomplete docstring in environment.py #560

chasgior214 opened this issue Feb 21, 2024 · 4 comments · Fixed by #565
Assignees
Labels
Docs Docs and examples related Environment Enviroment Class related features

Comments

@chasgior214
Copy link

Describe the bug

Incorrect/incomplete documentation of the Environment class's __init__ method.

To Reproduce

Open environment.py and go to the __init__ method (also here)

Expected behavior

Correct (no reference to launch rail length) and complete documentation.

@Gui-FernandesBR
Copy link
Member

Hello @chasgior214 , thank you for opening this issue.

I'm a bit lost tho, could you point me exactly what is wrong with the current documentation?
I don't see any reference to launch rail length and the documentation seems complete enough to me.

image

@Gui-FernandesBR Gui-FernandesBR added the Docs Docs and examples related label Feb 22, 2024
@Gui-FernandesBR Gui-FernandesBR moved this from Backlog to Next Version in LibDev Roadmap Feb 22, 2024
@Gui-FernandesBR Gui-FernandesBR added this to the Release v1.X.0 milestone Feb 22, 2024
@chasgior214
Copy link
Author

Hi @Gui-FernandesBR

The mention of launch rail length is at the top of the screenshot. There's also two incomplete bits. The first is the rest of that paragraph that has an unfinished sentence ("is loaded until another"). The second is an unfinished sentence in the description of the gravity parameter.

@Gui-FernandesBR
Copy link
Member

Hi @Gui-FernandesBR

The mention of launch rail length is at the top of the screenshot. There's also two incomplete bits. The first is the rest of that paragraph that has an unfinished sentence ("is loaded until another"). The second is an unfinished sentence in the description of the gravity parameter.

Got it. Thanks for specifying it. We will work on that soon enough

@Gui-FernandesBR Gui-FernandesBR added the Environment Enviroment Class related features label Feb 22, 2024
@Gui-FernandesBR
Copy link
Member

@phmbressan assigned to you, boss.

@phmbressan phmbressan linked a pull request Mar 24, 2024 that will close this issue
7 tasks
@github-project-automation github-project-automation bot moved this from Next Version to Closed in LibDev Roadmap Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Docs and examples related Environment Enviroment Class related features
Projects
Status: Closed
Development

Successfully merging a pull request may close this issue.

3 participants