Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update tutorial on adding new extensions #724

Merged

Conversation

duckontheweb
Copy link
Contributor

@duckontheweb duckontheweb commented Jan 21, 2022

Related Issue(s):

Description:

Updates the "Adding New and Custom Extensions" tutorial to be up-to-date with the new extensions API. The tutorial covers implementation of a PropertiesExtension sub-class that operates on Items, but does not cover summaries (a separate tutorial on creating summaries in general may be in order anyway).

Also updates the order of the TOC in the tutorials* pages to match the order of the tutorials in the index page.

PR Checklist:

  • Code is formatted (run pre-commit run --all-files)
  • Tests pass (run scripts/test)
  • Documentation has been updated to reflect changes, if applicable
  • This PR maintains or improves overall codebase code coverage.
  • Changes are added to the CHANGELOG. See the docs for information about adding to the changelog.

@codecov-commenter
Copy link

codecov-commenter commented Jan 21, 2022

Codecov Report

Merging #724 (3495885) into main (351f10f) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #724   +/-   ##
=======================================
  Coverage   94.33%   94.33%           
=======================================
  Files          77       77           
  Lines       11285    11285           
  Branches     1347     1347           
=======================================
  Hits        10646    10646           
  Misses        459      459           
  Partials      180      180           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 351f10f...3495885. Read the comment docs.

Copy link
Collaborator

@schwehr schwehr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only gave it a light read.

docs/tutorials/adding-new-and-custom-extensions.ipynb Outdated Show resolved Hide resolved
docs/tutorials/adding-new-and-custom-extensions.ipynb Outdated Show resolved Hide resolved
@duckontheweb duckontheweb requested a review from schwehr January 21, 2022 20:25
duckontheweb added a commit to duckontheweb/pystac that referenced this pull request Jan 21, 2022
@duckontheweb duckontheweb added this to the 1.4.0 milestone Jan 21, 2022
@duckontheweb duckontheweb force-pushed the fix/384-extensions-tutorial branch from 796717a to 3495885 Compare January 26, 2022 18:54
@duckontheweb duckontheweb added the documentation Issues related to PySTAC documentation label Jan 26, 2022
@duckontheweb
Copy link
Contributor Author

@lossyrob @matthewhanson I'll plan on merging this by the end of today if there isn't any additional feedback.

@duckontheweb duckontheweb merged commit d49d15a into stac-utils:main Jan 28, 2022
@duckontheweb duckontheweb deleted the fix/384-extensions-tutorial branch January 28, 2022 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues related to PySTAC documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update tutorial for adding new/custom extensions
4 participants