diff --git a/docs/source/examples/diffraction_objects_example.rst b/docs/source/examples/diffraction_objects_example.rst index 1122bf2..14aaa7b 100644 --- a/docs/source/examples/diffraction_objects_example.rst +++ b/docs/source/examples/diffraction_objects_example.rst @@ -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(xtype="tth", xvalue=90) intensity_at_ninety = diff_object1.on_tth()[1][tth_ninety_index] If you do not specify an ``xtype``, it will default to the ``xtype`` used when creating the ``DiffractionObject``. diff --git a/news/fix-example.rst b/news/fix-example.rst new file mode 100644 index 0000000..099f25c --- /dev/null +++ b/news/fix-example.rst @@ -0,0 +1,23 @@ +**Added:** + +* No news added: Fix the example of using DiffractionObject.get_array_index in the documenattion. + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*