Skip to content

Conversation

@jsignell
Copy link
Member

@jsignell jsignell commented May 31, 2023

Related Issue(s):

Description:

autodoc can always stand to be decluttered more, but in this PR I tried to make things a little better by:

  • removing inheritance from class docstrings
  • adding autosummary to some key pages

I also added a few stubs for extension classes where the docs were missing.

image
image

PR Checklist:

  • pre-commit hooks pass locally
  • 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.

@jsignell jsignell self-assigned this May 31, 2023
@jsignell jsignell requested a review from jpolchlo May 31, 2023 21:11
@codecov
Copy link

codecov bot commented May 31, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (d55cc15) 90.92% compared to head (c09c993) 90.92%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1137   +/-   ##
=======================================
  Coverage   90.92%   90.92%           
=======================================
  Files          49       49           
  Lines        6631     6631           
  Branches      975      975           
=======================================
  Hits         6029     6029           
  Misses        422      422           
  Partials      180      180           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Contributor

@jpolchlo jpolchlo left a comment

Choose a reason for hiding this comment

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

I guess this looks ok. I've no experience with autodoc to say if this is problematic or not. If that's ok by you, go ahead and merge; if not, seek a more informed reviewer?

@jsignell jsignell added this pull request to the merge queue Jun 7, 2023
Merged via the queue into stac-utils:main with commit 90f45c2 Jun 7, 2023
@jsignell jsignell deleted the docs branch June 7, 2023 16:46
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.

Cluttered autodoc output

2 participants