Skip to content

DOC: fix bug in custom StacIO example #879

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 8 commits into from
Nov 7, 2022

Conversation

martinfleis
Copy link
Contributor

@martinfleis martinfleis commented Aug 19, 2022

Description:

There is a bug in documentation in an example of a custom StacIO class caused by a mismatch of argument and variable names. This PR fixes it.

PR Checklist:

  • Documentation has been updated to reflect changes, if applicable
  • Changes are added to the CHANGELOG. See the docs for information about adding to the changelog.

@codecov-commenter
Copy link

codecov-commenter commented Aug 19, 2022

Codecov Report

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

Coverage data is based on head (0822543) compared to base (a897ff7).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #879   +/-   ##
=======================================
  Coverage   94.31%   94.31%           
=======================================
  Files          80       80           
  Lines       11923    11923           
  Branches     1130     1130           
=======================================
  Hits        11245    11245           
  Misses        496      496           
  Partials      182      182           

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.

Copy link
Contributor

@duckontheweb duckontheweb left a comment

Choose a reason for hiding this comment

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

Looks like there are a lot of formatting changes to the CHANGELOG included in this PR. They all look good to me, so I'm fine with including them.

@martinfleis Do you have some kind of linter that you ran on that file to generate those changes?

@martinfleis
Copy link
Contributor Author

Do you have some kind of linter that you ran on that file to generate those changes?

Ah, sorry about that! Yes, that is gonna be caused by markdownlint VS Code extension.

@gadomski gadomski merged commit b242850 into stac-utils:main Nov 7, 2022
@martinfleis martinfleis deleted the fix_s3_io branch November 7, 2022 20:24
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.

4 participants