Poliastro: Functional Description For `from_orbit` Method Not Rendered Correctly

Created on 11 Apr 2021  路  6Comments  路  Source: poliastro/poliastro

馃悶 Problem

The class method from_orbit description inside Ephem class is not being rendered correct & can be seen here in the latest documentation build.

馃挕 Possible solutions

Formatting the docstring for the from_orbit class method may fix the rendering issue. Care must be taken so as to adhere to the .rst format for Sphinx documentation generation for API Docs

bug documentation

Most helpful comment

Perhaps a transient version problem. I'll try to rebuild main and see what happens.

All 6 comments

https://github.com/poliastro/poliastro/blob/48bf2c6b64f3d35b005d0a60abe8bcd483adbced/src/poliastro/ephem.py#L313-L331

Unclear what's failing 馃 But we should investigate and fix it.

Yes, locally testing does render that part correctly but maybe something happened that causes the latest docs to not render it as expected...

Hello @astrojuanlu... This seems to be something weird going on ... I recently rebased the #1107 PR & then tried checking for the documentation of the from_orbit function ... and it fixes the documentation as seen here

Perhaps a transient version problem. I'll try to rebuild main and see what happens.

The Description in the from_orbit seems to render Correctly as per https://docs.poliastro.space/en/latest/autoapi/poliastro/ephem/index.html#poliastro.ephem.Ephem.from_orbit.So it Doesn't Look Unclear that what Should be rendered @DhruvSondhi :)

It got fixed after rebuilding the docs. Closing!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Phillip-M-Feldman picture Phillip-M-Feldman  路  4Comments

astrojuanlu picture astrojuanlu  路  5Comments

DhruvSondhi picture DhruvSondhi  路  3Comments

astrojuanlu picture astrojuanlu  路  6Comments

astrojuanlu picture astrojuanlu  路  7Comments