Skip to content

Update docs, tests, summaries for stable extensions#372

Merged
duckontheweb merged 17 commits into
stac-utils:mainfrom
duckontheweb:326-327-update-stable-extensions
Jun 2, 2021
Merged

Update docs, tests, summaries for stable extensions#372
duckontheweb merged 17 commits into
stac-utils:mainfrom
duckontheweb:326-327-update-stable-extensions

Conversation

@duckontheweb
Copy link
Copy Markdown
Contributor

Related Issue(s): #

Description:

  • Updates API docs for view, projection, and scientific extensions
  • Makes doi an optional argument for ScientificExtension and Publication to match spec
  • Implements summaries for view, projection, and scientific extensions
  • Simplifies summary getter/setter docstrings

stac-fields indicates that JSON Schema format should be used for sci:citation summaries, but using a simple list seemed more appropriate, so that's how I implemented it for now. @m-mohr @matthewhanson Maybe you have more insight around the rationale for using the JSON Schema summaries for that field?

PR Checklist:

  • Code is formatted (run scripts/format)
  • Tests pass (run scripts/test)
  • 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.

@duckontheweb duckontheweb changed the title 326 327 update stable extensions Update docs, tests, summaries for stable extensions May 28, 2021
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 28, 2021

Codecov Report

❌ Patch coverage is 98.54015% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 89.69%. Comparing base (c62f0fb) to head (0d406d1).
⚠️ Report is 1306 commits behind head on main.

Files with missing lines Patch % Lines
pystac/extensions/scientific.py 96.66% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #372      +/-   ##
==========================================
+ Coverage   89.43%   89.69%   +0.26%     
==========================================
  Files          39       39              
  Lines        5063     5154      +91     
==========================================
+ Hits         4528     4623      +95     
+ Misses        535      531       -4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@m-mohr
Copy link
Copy Markdown
Contributor

m-mohr commented May 28, 2021

Yeah, maybe "v" is better as "s" on citation.

We had the case where we had a regexp for the year number in the citation summary, which would be a use case. But I agree that in general, a list of values is probably the better option.

Opened PR stac-utils/stac-fields#11 for it.

m-mohr added a commit to stac-utils/stac-fields that referenced this pull request May 28, 2021
* Use default behavior (list of values) instead of schema

Origin: stac-utils/pystac#372
Comment thread pystac/extensions/scientific.py
Copy link
Copy Markdown
Member

@lossyrob lossyrob left a comment

Choose a reason for hiding this comment

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

Looking good, couple of suggestions but overall +1

Comment thread pystac/extensions/view.py Outdated
@duckontheweb duckontheweb merged commit 17ee2cc into stac-utils:main Jun 2, 2021
@duckontheweb duckontheweb deleted the 326-327-update-stable-extensions branch June 2, 2021 13:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants