Update pystac.utils docs #735
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #735 +/- ##
=======================================
Coverage 94.42% 94.42%
=======================================
Files 77 77
Lines 11312 11312
Branches 1346 1346
=======================================
Hits 10681 10681
Misses 453 453
Partials 178 178
Continue to review full report at Codecov.
|
duckontheweb
added a commit
to duckontheweb/pystac
that referenced
this pull request
Jan 31, 2022
duckontheweb
added a commit
to duckontheweb/pystac
that referenced
this pull request
Jan 31, 2022
duckontheweb
force-pushed
the
add/249-utils-documentation
branch
from
67818d4 to
49e78b2
Compare
duckontheweb
requested review from
gadomski
and removed request for
lossyrob
gadomski
requested changes
Feb 16, 2022
There was a problem hiding this comment.
I got two batches of warnings when building locally, wanted to see if they were worth fixing with this PR. First:
/Users/gadomski/Code/pystac/pystac/extensions/datacube.py:docstring of pystac.extensions.datacube:3: WARNING: hardcoded link 'https://github.com/stac-extensions/datacube' could be replaced by an extlink (try using ':stac-ext:`datacube`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/eo.py:docstring of pystac.extensions.eo:3: WARNING: hardcoded link 'https://github.com/stac-extensions/eo' could be replaced by an extlink (try using ':stac-ext:`eo`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/file.py:docstring of pystac.extensions.file:3: WARNING: hardcoded link 'https://github.com/stac-extensions/file' could be replaced by an extlink (try using ':stac-ext:`file`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/item_assets.py:docstring of pystac.extensions.item_assets:3: WARNING: hardcoded link 'https://github.com/stac-extensions/item-assets' could be replaced by an extlink (try using ':stac-ext:`item-assets`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/label.py:docstring of pystac.extensions.label:3: WARNING: hardcoded link 'https://github.com/stac-extensions/label' could be replaced by an extlink (try using ':stac-ext:`label`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/pointcloud.py:docstring of pystac.extensions.pointcloud:3: WARNING: hardcoded link 'https://github.com/stac-extensions/pointcloud' could be replaced by an extlink (try using ':stac-ext:`pointcloud`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/projection.py:docstring of pystac.extensions.projection:3: WARNING: hardcoded link 'https://github.com/stac-extensions/projection' could be replaced by an extlink (try using ':stac-ext:`projection`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/raster.py:docstring of pystac.extensions.raster:3: WARNING: hardcoded link 'https://github.com/stac-extensions/raster' could be replaced by an extlink (try using ':stac-ext:`raster`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/raster.py:docstring of pystac.extensions.raster.RasterBand.apply:: WARNING: hardcoded link 'https://github.com/stac-extensions/raster/#data-types' could be replaced by an extlink (try using ':stac-ext:`raster/#data-types`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/raster.py:docstring of pystac.extensions.raster.RasterBand.create:: WARNING: hardcoded link 'https://github.com/stac-extensions/raster/#data-types' could be replaced by an extlink (try using ':stac-ext:`raster/#data-types`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/sar.py:docstring of pystac.extensions.sar:3: WARNING: hardcoded link 'https://github.com/stac-extensions/sar' could be replaced by an extlink (try using ':stac-ext:`sar`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/sat.py:docstring of pystac.extensions.sat:3: WARNING: hardcoded link 'https://github.com/stac-extensions/sat' could be replaced by an extlink (try using ':stac-ext:`sat`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/scientific.py:docstring of pystac.extensions.scientific:3: WARNING: hardcoded link 'https://github.com/stac-extensions/scientific' could be replaced by an extlink (try using ':stac-ext:`scientific`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/table.py:docstring of pystac.extensions.table:3: WARNING: hardcoded link 'https://github.com/stac-extensions/table' could be replaced by an extlink (try using ':stac-ext:`table`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/timestamps.py:docstring of pystac.extensions.timestamps:3: WARNING: hardcoded link 'https://github.com/stac-extensions/timestamps' could be replaced by an extlink (try using ':stac-ext:`timestamps`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/version.py:docstring of pystac.extensions.version:3: WARNING: hardcoded link 'https://github.com/stac-extensions/version' could be replaced by an extlink (try using ':stac-ext:`version`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/version.py:docstring of pystac.extensions.version.VersionRelType:3: WARNING: hardcoded link 'https://github.com/stac-extensions/version#relation-types' could be replaced by an extlink (try using ':stac-ext:`version#relation-types`' instead)
/Users/gadomski/Code/pystac/pystac/extensions/view.py:docstring of pystac.extensions.view:3: WARNING: hardcoded link 'https://github.com/stac-extensions/view' could be replaced by an extlink (try using ':stac-ext:`view`' instead)
/Users/gadomski/Code/pystac/docs/quickstart.ipynb:736: WARNING: hardcoded link 'https://github.com/stac-extensions/eo' could be replaced by an extlink (try using ':stac-ext:`eo`' instead)
/Users/gadomski/Code/pystac/docs/quickstart.ipynb:736: WARNING: hardcoded link 'https://github.com/stac-extensions/view' could be replaced by an extlink (try using ':stac-ext:`view`' instead)
/Users/gadomski/Code/pystac/docs/quickstart.ipynb:736: WARNING: hardcoded link 'https://github.com/stac-extensions/projection' could be replaced by an extlink (try using ':stac-ext:`projection`' instead)
/Users/gadomski/Code/pystac/docs/quickstart.ipynb:817: WARNING: hardcoded link 'https://github.com/stac-extensions/eo#item-properties-or-asset-fields' could be replaced by an extlink (try using ':stac-ext:`eo#item-properties-or-asset-fields`' instead)
Second:
/Users/gadomski/Code/pystac/pystac/serialization/identify.py:docstring of pystac.serialization.identify.STACJSONDescription.extensions:1: WARNING: duplicate object description of pystac.serialization.identify.STACJSONDescription.extensions, other instance in api/serialization/identify, use :noindex: for one of them
/Users/gadomski/Code/pystac/pystac/serialization/identify.py:docstring of pystac.serialization.identify.STACJSONDescription.object_type:1: WARNING: duplicate object description of pystac.serialization.identify.STACJSONDescription.object_type, other instance in api/serialization/identify, use :noindex: for one of them
/Users/gadomski/Code/pystac/pystac/serialization/identify.py:docstring of pystac.serialization.identify.STACJSONDescription.version_range:1: WARNING: duplicate object description of pystac.serialization.identify.STACJSONDescription.version_range, other instance in api/serialization/identify, use :noindex: for one of them
I also have a couple of inline comments re: quick fixups.
duckontheweb
added a commit
to duckontheweb/pystac
that referenced
this pull request
Feb 22, 2022
duckontheweb
force-pushed
the
add/249-utils-documentation
branch
from
49e78b2 to
8ab2c84
Compare
This first batch of warnings was due to our use of hard-coded links in a lot of the extension modules (e.g. here) and in some of our tutorial notebooks. 6fc5008 replaces the hard-coded links in the source code with
This batch of warnings is fixed by 3d75e7a |
|
I had to configure |
duckontheweb
force-pushed
the
add/249-utils-documentation
branch
from
befe15f to
5f99061
Compare
gadomski
approved these changes
Feb 22, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issue(s):
Description:
Updates docstrings with references to internal and external API docs and adds more detail to some of the docstrings.
PR Checklist:
pre-commit run --all-files)scripts/test)