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.

Sign up for GitHub

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

Jump to bottom

Make layout_strategy default value consistent #967

Merged
merged 6 commits into from
Jan 27, 2023
Merged

Make layout_strategy default value consistent #967

merged 6 commits into from
Jan 27, 2023

Conversation

pjhartzell
Copy link
Collaborator

@pjhartzell pjhartzell commented Jan 26, 2023 •
edited
Loading

Related Issue(s): #

Description:

  • Updates docstrings to make users aware of the default layout strategy.
  • Adds an optional strategy parameter to the catalog add_items() method.
  • Updates docstring formatting in several places to correct rendering in the API docs.

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.

@pjhartzell
Copy link
Collaborator Author

pjhartzell commented Jan 26, 2023 •
edited
Loading

@gadomski This went a bit deeper than I initially expected, which gives me some pause about the changes.

@pjhartzell pjhartzell requested a review from gadomski January 26, 2023 23:07
@pjhartzell pjhartzell self-assigned this Jan 26, 2023
gadomski
gadomski requested changes Jan 27, 2023
View reviewed changes
pystac/catalog.py Outdated Show resolved Hide resolved
@pjhartzell pjhartzell requested a review from gadomski January 27, 2023 16:25
@pjhartzell pjhartzell marked this pull request as ready for review January 27, 2023 18:28
@codecov-commenter
Copy link

codecov-commenter commented Jan 27, 2023 •
edited
Loading

Codecov Report

Base: 90.09% // Head: 90.09% // No change to project coverage 👍

Coverage data is based on head (c30f76f) compared to base (98246a0).
Patch coverage: 100.00% of modified lines in pull request are covered.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #967    /-   ##
=======================================
  Coverage   90.09%   90.09%           
=======================================
  Files          47       47           
  Lines        6086     6086           
  Branches      913      913           
=======================================
  Hits         5483     5483           
  Misses        422      422           
  Partials      181      181
Impacted Files Coverage Δ
pystac/collection.py 93.43% <ø> (ø)
pystac/layout.py 87.86% <ø> (ø)
pystac/stac_object.py 91.97% <ø> (ø)
pystac/catalog.py 91.96% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@pjhartzell pjhartzell merged commit 9d2014f into stac-utils:main Jan 27, 2023
@pjhartzell pjhartzell deleted the issues/965-consistent-layout-strategy branch January 27, 2023 20:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gadomski gadomski gadomski approved these changes

Assignees

@pjhartzell pjhartzell

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make layout strategy arguments consistent
3 participants
@pjhartzell @codecov-commenter @gadomski