Skip to content

Incorrect/incomplete docstring in environment.py #560

Closed

Description

@chasgior214

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.

Activity

  1. Gui-FernandesBR commented on Feb 22, 2024

    @Gui-FernandesBR
    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

  2. moved this from Backlog to Next Version in LibDev Roadmapon Feb 22, 2024
  3. chasgior214 commented on Feb 22, 2024

    @chasgior214
    ContributorAuthor

    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.

  4. Gui-FernandesBR commented on Feb 22, 2024

    @Gui-FernandesBR
    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

  5. Gui-FernandesBR commented on Feb 22, 2024

    @Gui-FernandesBR
    Member

    @phmbressan assigned to you, boss.

  6. moved this from Next Version to Closed in LibDev Roadmapon Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

DocsDocs and examples relatedEnvironmentEnviroment Class related features

Type

No type

Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions