docs: replace Placeholder docstrings with meaningful descriptions#1288
Merged
mfisher87 merged 1 commit intoApr 9, 2026
Merged
Conversation
Replace all 14 "Placeholder" subject lines with concise descriptions of what each function returns or does, based on the function implementation and existing parameter/return annotations. Fixes earthaccess-dev#597
|
I will automatically update this comment whenever this PR is modified |
Member
|
Nice, thanks Matt! |
Contributor
Author
|
Thanks for the review and merge, @mfisher87! |
Member
|
No worries, I really appreciated this contribution! This can has been kicked down the road for too long and I'm so glad you joined us and took care of it :) |
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
3 participants
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.
Summary
Replaces all 14 "Placeholder" docstring subject lines with concise descriptions based on each function's implementation.
Changes
earthaccess/results.py: 13 placeholder subject lines replaced (DataCollection and DataGranule methods)earthaccess/search.py: 1 placeholder subject line replacedEach new subject line follows imperative mood and describes what the function returns or does.
Fixes #597
This contribution was developed with AI assistance (Codex).
📚 Documentation preview 📚: https://earthaccess--1288.org.readthedocs.build/en/1288/