docs: fix the example of using DiffractionObject.get_array_index in the documentation
#354
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 #354 +/- ##
========================================
Coverage ? 100.00%
========================================
Files ? 9
Lines ? 516
Branches ? 0
========================================
Hits ? 516
Misses ? 0
Partials ? 0 🚀 New features to boost your workflow:
|
|
@sbillinge, it's ready for review. |
sbillinge
reviewed
Jul 25, 2025
|
@sbillinge , this PR only fixes the documentation. I will handle the |
sbillinge
reviewed
Jul 25, 2025
| @@ -180,7 +180,7 @@ For example, attempting to add a diffraction object and a string will raise an e | |||
|
|
|||
| .. code-block:: python | |||
|
|
|||
| tth_ninety_index = diff_object1.get_array_index(90, xtype="tth") | |||
| tth_ninety_index = diff_object1.get_array_index(xvalue=90, xtype="tth") | |||
There was a problem hiding this comment.
This will have to be fixed later when we finalize the signature. Let's just remember to do it....
| @@ -190,8 +190,8 @@ you can find its closest index for ``q=0.25`` by typing either of the following: | |||
| .. code-block:: python | |||
|
|
|||
| print(do._input_xtype) # remind ourselves which array was input. prints "q" in this case. | |||
| index = do.get_array_index(0.25) # no xtype passed, defaults to do._input_xtype, or in this example, q | |||
| index = do.get_array_index(0.25, xtype="q") # explicitly choose an xtype to specify a value | |||
| index = do.get_array_index(xvalue=0.25) # no xtype passed, defaults to do._input_xtype, or in this example, q | |||
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
Fix the examples as mentioned in #352
DiffractionObject.get_array_indexdiffpy.utils.transform.d_to_tthFix the documentation examples.
What should reviewer(s) do
Please check the modified documentation.
example for
DiffractionObject.get_array_indexDuplicate code block is removed
Markup is now rendered correctly
