tudat-team / tudatpy

A Python platform to perform astrodynamics and space research.

Home Page:https://tudat-space.readthedocs.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Hide Overloads in API Documentation

geoffreygarrett opened this issue · comments

Description

This issue is regarding the overloads found in the API documentation. The formatting of the overloads makes for an unattractive API. While the overloads should eventually be deprecated, there is no timeline for it yet. In the meantime, we should hide the rendered overloads in the API docs.

Checklist

  • Hide rendered overloads in the API documentation
  • Modifications to the changelog

Additional Information [source]

overload_issue