docs: fix the example of using DiffractionObject.get_array_index in the documentation
#353
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
… the documentation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #353 +/- ##
========================================
Coverage ? 100.00%
========================================
Files ? 9
Lines ? 516
Branches ? 0
========================================
Hits ? 516
Misses ? 0
Partials ? 0 🚀 New features to boost your workflow:
|
|
It is closed because there are some details that need to be figured out first. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 problem does this PR address
Closes #352
In the documentation, running the example code of
DiffractionObject.get_array_indexwill throw an error.This PR updates the example code of this function.
What should the reviewer(s) do
Please check the updated documentation.