RocketPy icon indicating copy to clipboard operation
RocketPy copied to clipboard

Incorrect/incomplete docstring in environment.py

Open chasgior214 opened this issue 1 year ago • 4 comments

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.

chasgior214 avatar Feb 21 '24 04:02 chasgior214

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 avatar Feb 22 '24 19:02 Gui-FernandesBR

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.

chasgior214 avatar Feb 22 '24 20:02 chasgior214

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 avatar Feb 22 '24 20:02 Gui-FernandesBR

@phmbressan assigned to you, boss.

Gui-FernandesBR avatar Feb 22 '24 21:02 Gui-FernandesBR