Repository navigation
docs: minor formatting fixes - #13
Merged
Merged
Conversation
Link the first mention of each documented object on a page or in a rendered docstring. That covers earthaccess_auth's own API, obstore, icechunk, obspec-utils, Python, xarray, fsspec, s3fs, and requests. Add the inventories those links need. Replace the two relative api.md#anchor links with autorefs. Module docstrings and private classes are not rendered, so they stay unlinked. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does
Various improvements to docs formatting and phrasing.
Checklist
CHANGELOG.mdentry added (for user-visible changes)uv run pytest,uv run mypy, anduvx prek run -apass locally