search

tudat-team / tudat-space

An introduction and guide to tudat-space.
https://tudat-space.readthedocs.io
14 stars 17 forks source link

Update state definition documentation to new format #138

Closed larshinueber closed 1 month ago

larshinueber commented 2 months ago

PR Scope

It seems that the documentation of the available state definitions and conversions follows an old documentation format, which is updated and restructured to separate translational and rotational states. Some minor formatting and typo fixes are included.

Before Merging

Please verify that the build works correctly before merging, in particular the Note box in the Kepler element section. In my local build the box does not end as intended after "... as it does not possess a gravitational parameter.", but only once the next section on spherical elements is started, see below. It seems to be an issue on my side, as all boxes (also in other pages which were not modified) show this behavior. This could not be resolved and might be related to my local build environment, see also this pull request.

image

DominicDirkx commented 2 months ago

Thanks for all these corrections! I see that in this file:

https://github.com/tudat-team/tudat-space/pull/138/files#diff-ab4d62f08f357ee2ccfe36420f1ca997d2ee30f36d5f4ecabf2d0102383fdf31

The 'points of attention' have been added, which I think were recently all moved (or slated to be moved) to the API documentation. I'm assuming these show up here by accident due to a merge conflict or something, but wanted to check.

larshinueber commented 1 month ago

Hi Dominic, you're right, thank you for pointing it out! I branched off the master branch instead of the develop branch and was then missing the updates. I tried to fix it by rebasing onto develop, but it seems to mess up the history and while still including the points of attention.

As a quick fix I will open a new PR, as the changes here are not conflicting with any other commit made in the meantime, which should keep the history clean.