Skip to content

Commit dab7ee6

Browse files
committed
docs: fix the example of using DiffractionObject.get_array_index in the documentation
1 parent 7eb9f5c commit dab7ee6

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

docs/source/examples/diffraction_objects_example.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ For example, attempting to add a diffraction object and a string will raise an e
180180

181181
.. code-block:: python
182182
183-
tth_ninety_index = diff_object1.get_array_index(90, xtype="tth")
183+
tth_ninety_index = diff_object1.get_array_index(xtype="tth", xvalue=90)
184184
intensity_at_ninety = diff_object1.on_tth()[1][tth_ninety_index]
185185
186186
If you do not specify an ``xtype``, it will default to the ``xtype`` used when creating the ``DiffractionObject``.

news/fix-example.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**Added:**
2+
3+
* No news added: Fix the example of using DiffractionObject.get_array_index in the documenattion.
4+
5+
**Changed:**
6+
7+
* <news item>
8+
9+
**Deprecated:**
10+
11+
* <news item>
12+
13+
**Removed:**
14+
15+
* <news item>
16+
17+
**Fixed:**
18+
19+
* <news item>
20+
21+
**Security:**
22+
23+
* <news item>

0 commit comments

Comments
 (0)