Fix up docs linking #1499
Fix up docs linking #1499
Conversation
| .. automodule:: pystac.asset | ||
| :members: | ||
| :undoc-members: | ||
| :exclude-members: Asset |
There was a problem hiding this comment.
This pattern makes it so you can have the Asset indexed as pystac.Asset and the rest of the module as pystac.asset.whatever
| ("py:class", "Datetime"), | ||
| ("py:class", "L"), | ||
| ("py:class", "pystac.summaries.T"), | ||
| ("py:class", "HREF"), # this one partially works |
There was a problem hiding this comment.
this was killing me. It works in some cases but not others. It was incredibly frustrating to try to figure out and in the end I gave up.
| @@ -418,7 +418,7 @@ def sort_function(links: list[Link]) -> list[Link]: | |||
| ) | |||
|
|
|||
| children = map( | |||
| lambda x: cast(Union[pystac.Catalog, pystac.Collection], x), | |||
| lambda x: cast(pystac.Catalog | pystac.Collection, x), | |||
There was a problem hiding this comment.
I probably shouldn't have done this replace Union with | in this PR. Sorry.
| @@ -26,6 +25,8 @@ | |||
| from pystac.serialization.identify import STACJSONDescription, STACVersionID | |||
| from pystac.utils import get_required, map_opt | |||
|
|
|||
| #: Generalized version of :class:`~pystac.Item`, :class:`~pystac.Asset`, | |||
| #: :class:`~pystac.ItemAssetDefinition` or :class:`~pystac.extensions.raster.RasterBand` | |||
There was a problem hiding this comment.
These make the TypeVars almost work in a normal way.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1499 +/- ##
=======================================
Coverage 91.44% 91.44%
=======================================
Files 54 54
Lines 7501 7505 +4
Branches 906 906
=======================================
+ Hits 6859 6863 +4
Misses 457 457
Partials 185 185 ☔ View full report in Codecov by Sentry. |
Related Issue(s):
Description:
That was a real slog. Yeesh. At least it encouraged me to add some more docs for
.ext🤷🏻PR Checklist:
scripts/test)