GeoTrellis Types Representation #654
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
…tuples Updated and added docstings to the geotrellis package
jbouffard
force-pushed
the
improvement/geotrellis-types/classes
branch
from
667f4bf
to
8b976db
Compare
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.
This PR changes some of the GeoTrellis types from
namedtuples to sub-classes ofnamedtuples. The reason for this is because of how they're represented in the documentation. For example, theGlobalLayoutsection of the API docs does not have any of the type's docstrings https://geopyspark.readthedocs.io/en/latest/docs/geopyspark.geotrellis.html#geopyspark.geotrellis.GlobalLayout because Sphinx don't know how to include docstrings to anamedtuple. WhereasLocalLayoutis a sub-class ofnamedtuple, and its docstrings are visible in the docs https://geopyspark.readthedocs.io/en/latest/docs/geopyspark.geotrellis.html#geopyspark.geotrellis.LocalLayout