Giters

tudat-team / tudat-multidoc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Collection of small edits to make on API docs

jo11he opened this issue · comments

commented

  • member function estimation_setup.create_parameter_set missing function argument parameter_settings

  • class estimation.PodInput constructor has wrong return type and description (copy/paste error from the ConvergenceChecker)

  • create_one_dimensional_vector_interpolator parameter data_to_interpolate is duplicated, placed instead of data_first_derivatives - however, part of the parameter description fits the data_first_derivatives!

  • #41

  • #46

  • Add docstrings and API doc for environment_setup.create_simplified_system_of_bodies(). The description of this function is already given here.

  • typo in estimation_setup.parameter.gravitational_parameter box on requirements (gravitu_field)

  • docs missing for enums in estimation_setup.parameter module, EstimatebleParametersEnum is not unimportant so I think we should make sure this is fixed. --> found this was a matter of renaming tudatpy name EstimatebleParameterTypes to a more English EstimatableParameterTypes and fixed that right away

commented

EDIT (Dominic): Moved your point into the top post

commented

Silly question; been a long day. Did I accidentally click this (in the post above):

  • Add docstrings and API doc for environment_setup.create_simplified_system_of_bodies(). The description of this function is already given here.

or did someone add it? I don't recall adding this...

commented

I sneakily added this a few hours ago at the same time of changing the doc of the new plotting.pareto_front function. And I clicked it off the list 🙂