Skip to content

Fix docs for StacIO.read/write_text#835

Merged
duckontheweb merged 2 commits into
stac-utils:mainfrom
duckontheweb:fix/764-stac-io-docs
Jun 29, 2022
Merged

Fix docs for StacIO.read/write_text#835
duckontheweb merged 2 commits into
stac-utils:mainfrom
duckontheweb:fix/764-stac-io-docs

Conversation

@duckontheweb
Copy link
Copy Markdown
Contributor

@duckontheweb duckontheweb commented Jun 28, 2022

Related Issue(s):

Description:

Fixes docstrings for StacIO.read_text and StacIO.write_text to match the type annotations for the source argument.

cc: @l0b0

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.

@duckontheweb duckontheweb requested a review from gadomski June 28, 2022 16:12
@duckontheweb duckontheweb added this to the 1.5.0 milestone Jun 28, 2022
@duckontheweb duckontheweb added bug Things which are broken documentation Issues related to PySTAC documentation labels Jun 28, 2022
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jun 28, 2022

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.34%. Comparing base (a6fffa5) to head (3d48641).
⚠️ Report is 669 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #835   +/-   ##
=======================================
  Coverage   94.34%   94.34%           
=======================================
  Files          83       83           
  Lines       11923    11923           
  Branches     1390     1390           
=======================================
  Hits        11249    11249           
  Misses        495      495           
  Partials      179      179           

☔ 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.

@duckontheweb duckontheweb merged commit afc12cc into stac-utils:main Jun 29, 2022
@duckontheweb duckontheweb deleted the fix/764-stac-io-docs branch June 29, 2022 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Things which are broken documentation Issues related to PySTAC documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Discrepancy between documentation and source of StacIO read_text & write_text

3 participants