Skip to content

Fix docs for StacIO.read/write_text #835

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

Merged
merged 2 commits into from
Jun 29, 2022

Conversation

duckontheweb
Copy link
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

Codecov Report

Merging #835 (3d48641) into main (a6fffa5) will not change coverage.
The diff coverage is n/a.

@@           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           
Impacted Files Coverage Δ
pystac/stac_io.py 87.38% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a6fffa5...3d48641. Read the comment docs.

@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