You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The reference/API section for some subpackages can be quite long - e.g., astropy.units has several dozen functions and classes (see https://docs.astropy.org/en/stable/units/ref_api.html). Hence, order matters to find something. On stable, order is alphabetical, but on dev it has become by alphabetical by submodule things are imported from, because that is how __all__ is defined (which was introduced by #15862).
The question now is what to do. Options:
Sort __all__ and always make things alphabetical
Somehow introduce headings between items. This would have the benefit that it would make it unnecessary to also display, e.g., the contents of astropy.units.equivalencies. But might also make things less findable.
Other?
Describe the desired outcome
A clean reference/API page without needless duplication.
I put a milestone here since I think we should decide on some ordering before we release the next stable docs (reverting to sorted alphabetically if we cannot think of something better).
Additional context
No response
The text was updated successfully, but these errors were encountered:
What is the problem this feature will solve?
The reference/API section for some subpackages can be quite long - e.g.,
astropy.units
has several dozen functions and classes (see https://docs.astropy.org/en/stable/units/ref_api.html). Hence, order matters to find something. Onstable
, order is alphabetical, but ondev
it has become by alphabetical by submodule things are imported from, because that is how__all__
is defined (which was introduced by #15862).The question now is what to do. Options:
__all__
and always make things alphabeticalastropy.units.equivalencies
. But might also make things less findable.Describe the desired outcome
A clean reference/API page without needless duplication.
I put a milestone here since I think we should decide on some ordering before we release the next stable docs (reverting to sorted alphabetically if we cannot think of something better).
Additional context
No response
The text was updated successfully, but these errors were encountered: