docs for diffraction objects #249
Merged
Conversation
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
|
Warning! No news item is found for this PR. If this is a user-facing change/feature/fix, |
yucongalicechen
commented
Dec 18, 2024
| and a ``metadata`` dictionary containing relevant information about the data. Here's an example: | ||
|
|
||
| .. code-block:: python | ||
| import numpy as np |
Contributor
Author
There was a problem hiding this comment.
this is a direct copy-paste from the docstring
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #249 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 8 8
Lines 380 380
=========================================
Hits 380 380 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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 #183
I wrote the docs for all tested functions in diffraction objects (a little bit more than what the original issue was asking for).
Made a new issue #248 that covers the docs for other functions.
@sbillinge ready for review