Skip to content

docs: fix the example of using DiffractionObject.get_array_index in the documentation #354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sbillinge merged 4 commits into from
Jul 25, 2025
Merged

docs: fix the example of using DiffractionObject.get_array_index in the documentation #354

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0cb0a04
docs: fix the example of using `DiffractionObject.get_array_index` in…
ycexiao Jul 24, 2025
14ec0bc
docs: remove a duplicate code block
ycexiao Jul 24, 2025
174f2be
docs: fix the `.rst` markup
ycexiao Jul 24, 2025
829d62a
chore: update news
ycexiao Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: fix the .rst markup
  • Loading branch information
@ycexiao
ycexiao committed Jul 24, 2025
commit 174f2be1ebc27129f061d34e9fcf787896adc2c3
3 changes: 1 addition & 2 deletions docs/source/examples/parsers_example.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,7 @@ Now we can extract specific data table columns from the dictionary.

parsed_file_data = serialize_data('<PATH to data.txt>', hdata, data_table, serial_file='<PATH to serialfile.json>')

The returned value, ``parsed_file_data``, is the dictionary we just added to ``serialfile.json``.
To extract the data from the serial file, we use ``deserialize_data``.
The returned value, ``parsed_file_data``, is the dictionary we just added to ``serialfile.json``. To extract the data from the serial file, we use ``deserialize_data``.

.. code-block:: python

Expand Down