Documentation update for measurement#8038
Merged
Merged
Conversation
ayshih
requested changes
Jan 28, 2025
Member
ayshih
left a comment
There was a problem hiding this comment.
See my suggestion for a much simpler docstring
Also, please add a trivial changelog entry
Co-authored-by: Albert Y. Shih <[email protected]>
nabobalis
reviewed
Jan 28, 2025
Member
|
As Albert was saying, can you add a changelog? There are instructions here: https://github.com/sunpy/sunpy/blob/main/changelog/README.rst |
Co-authored-by: Nabil Freij <[email protected]>
Member
|
Can you also fix the issues that the pre-commit.ci has found? |
nabobalis
reviewed
Jan 28, 2025
nabobalis
reviewed
Jan 28, 2025
Member
|
Unfortunately, the pre-commit is still failing. |
Contributor
|
hey @parharti write this in converstion |
Contributor
Author
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
nabobalis
reviewed
Jan 30, 2025
Co-authored-by: Albert Y. Shih <[email protected]>
meeseeksmachine
pushed a commit
to meeseeksmachine/sunpy
that referenced
this pull request
Jan 30, 2025
Member
meeseeksmachine
pushed a commit
to meeseeksmachine/sunpy
that referenced
this pull request
Jan 30, 2025
nabobalis
pushed a commit
that referenced
this pull request
Jan 30, 2025
Co-authored-by: Prisha Sharma <[email protected]>
nabobalis
pushed a commit
that referenced
this pull request
Jan 30, 2025
Co-authored-by: Prisha Sharma <[email protected]>
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
4 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.
Closes #4802
This PR updates the documentation for the measurement property in the GenericMap class. It clarifies the default behavior of retrieving wavelength from the WAVELNTH FITS keyword, handling missing WAVEUNIT keywords, and how subclasses can override the property to return other observables (e.g., LOS magnetograms, continuum intensity).
Thanks to everyone who helped by sharing their doubts and communication, which significantly improved my understanding of the problem statement.
This update does not affect existing code functionality but improves documentation clarity