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
{{ message }}
Repository navigation
Add narrative documentation on physical types #11588
In #11204 we made the physical_type attribute of units into instances of the new PhysicalType class. Before this, physical_type returned a string. It's now possible to do dimensional analysis along the lines of:
There are descriptions on how to use physical types in the docstrings for PhysicalType, get_physical_type, and UnitBase.physical_type. Following a suggestion in #11204, it would be helpful to add a discussion of physical types in the narrative documentation for astropy.units.
It might be helpful to write out or have a table of all of the names of physical types. I'm not sure if this would be best in the narrative documentation or in the docstring for get_physical_type.
Reacted by Marten van Kerkwijk and Nathaniel Starkman
It might be helpful to write out or have a table of all of the names of physical types. I'm not sure if this would be best in the narrative documentation or in the docstring for get_physical_type.
If it's in the narrative docs we might be able to x-ref to it so that physical types can better be incorporated into docstrings
Activity
nstarman commentedon Apr 17, 2021
If it's in the narrative docs we might be able to x-ref to it so that physical types can better be incorporated into docstrings
@adrn, #11555