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

Remove text around to_dict and JSON #1074

Merged
merged 4 commits into from
Apr 11, 2023
Merged

Remove text around to_dict and JSON #1074

merged 4 commits into from
Apr 11, 2023

Conversation

gadomski
Copy link
Member

@gadomski gadomski commented Mar 31, 2023

Related Issue(s):

Description:

Our to_dict methods do not always return objects that are strictly valid as JSON, e.g. they may contain tuples instead of lists. This PR updates all docstrings to remove references to returning valid JSON.

PR Checklist:

@gadomski gadomski added the documentation Issues related to PySTAC documentation label Mar 31, 2023
@gadomski gadomski added this to the 1.8 milestone Mar 31, 2023
@gadomski gadomski requested a review from philvarner March 31, 2023 15:00
@gadomski gadomski self-assigned this Mar 31, 2023
@gadomski gadomski requested a review from pjhartzell April 6, 2023 13:09
@gadomski gadomski added this pull request to the merge queue Apr 11, 2023
Merged via the queue into main with commit 0f90e7a Apr 11, 2023
@gadomski gadomski deleted the issues/1047-to-dict-docs branch April 11, 2023 13:02
@gadomski
Copy link
Member Author

Created #1092 to capture the serialization discussion.

Copy link

codecov bot commented Aug 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.23%. Comparing base (3d258ab) to head (90aff00).
Report is 215 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1074   +/-   ##
=======================================
  Coverage   90.23%   90.23%           
=======================================
  Files          47       47           
  Lines        6236     6236           
  Branches      936      936           
=======================================
  Hits         5627     5627           
  Misses        428      428           
  Partials      181      181           

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

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.

Expectations of to_dict methods in returning JSON-typed values, regarding geometry
2 participants