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

Cleanup deprecation docs #302

Merged
merged 2 commits into from
Aug 19, 2022
Merged

Cleanup deprecation docs #302

merged 2 commits into from
Aug 19, 2022

Conversation

gadomski
Copy link
Member

Description:

Clean up the documentation and warning messages for the recent deprecations. Also includes some light reformatting of docstrings to quiet some sphinx warnings/errors.

PR Checklist:

  • Code is formatted
  • Tests pass
  • Changes are added to the CHANGELOG

Things were a bit inconsistent, this brings them all into the same format. Also, orders the ItemSearch methods by source
order, so the deprecated methods are lower on the API page.
@gadomski gadomski requested a review from philvarner August 19, 2022 13:56
@gadomski gadomski added this to the 0.5.0 milestone Aug 19, 2022
@codecov-commenter
Copy link

Codecov Report

Merging #302 (4b8e732) into main (c32b5a8) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #302   +/-   ##
=======================================
  Coverage   84.90%   84.90%           
=======================================
  Files          11       11           
  Lines         775      775           
=======================================
  Hits          658      658           
  Misses        117      117           
Impacted Files Coverage Δ
pystac_client/client.py 84.84% <ø> (ø)
pystac_client/item_search.py 92.83% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@gadomski gadomski merged commit 4ab5770 into main Aug 19, 2022
@gadomski gadomski deleted the cleanup-deprecations branch August 19, 2022 18:27
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.

3 participants