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

Allow to pass a dict for the summarized fields, fix the doc rendering #1195

Merged
merged 2 commits into from
Aug 1, 2023

Conversation

m-mohr
Copy link
Contributor

@m-mohr m-mohr commented Aug 1, 2023

Related Issue(s):

  • None

Description:

This implements two changes:

  • Allow to pass a Dict with field names and summary strategies. Some people didn't realize they could set the summaryfields property so this makes it more obvious that you don't necessarily need to create a JSON file.
  • Fix the foc rendering:
    grafik
  • Generally improve the summaries section a bit based on questions that I was asked during consulting.

PR Checklist:

  • pre-commit hooks pass locally
  • 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.

@m-mohr m-mohr requested a review from gadomski August 1, 2023 10:24
@m-mohr m-mohr force-pushed the summarizer-fixes branch 4 times, most recently from a079c46 to 32d586e Compare August 1, 2023 11:07
@stac-utils stac-utils deleted a comment from codecov bot Aug 1, 2023
@codecov
Copy link

codecov bot commented Aug 1, 2023

Codecov Report

Patch coverage: 92.85% and no project coverage change.

Comparison is base (ebe5c6b) 92.01% compared to head (a9d016f) 92.01%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1195   +/-   ##
=======================================
  Coverage   92.01%   92.01%           
=======================================
  Files          51       51           
  Lines        6809     6813    +4     
  Branches     1007     1009    +2     
=======================================
+ Hits         6265     6269    +4     
  Misses        368      368           
  Partials      176      176           
Files Changed Coverage Δ
pystac/summaries.py 77.77% <92.85%> (+0.48%) ⬆️

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

@m-mohr m-mohr force-pushed the summarizer-fixes branch 2 times, most recently from 5d345e0 to eb79166 Compare August 1, 2023 11:17
Copy link
Member

@jsignell jsignell left a comment

Choose a reason for hiding this comment

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

This looks good to me! Nice clean up 👍

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@jsignell jsignell added this pull request to the merge queue Aug 1, 2023
Merged via the queue into main with commit 9ab10cc Aug 1, 2023
22 checks passed
@jsignell jsignell deleted the summarizer-fixes branch August 1, 2023 20:06
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.

2 participants