Skip to content

Commit 1442c7c

Browse files
committed
Update docs without scttering objects layer
1 parent 4132f14 commit 1442c7c

File tree

5 files changed

+21
-32
lines changed

5 files changed

+21
-32
lines changed

doc/source/api/diffpy.utils.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,20 @@ diffpy.utils.resampler module
3636
:members:
3737
:undoc-members:
3838
:show-inheritance:
39+
40+
41+
diffpy.utils.user_config module
42+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
43+
44+
.. automodule:: diffpy.utils.user_config
45+
:members:
46+
:undoc-members:
47+
:show-inheritance:
48+
49+
diffpy.utils.diffraction_objects module
50+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
51+
52+
.. automodule:: diffpy.utils.diffraction_objects
53+
:members:
54+
:undoc-members:
55+
:show-inheritance:

doc/source/api/diffpy.utils.scattering_objects.rst

Lines changed: 0 additions & 28 deletions
This file was deleted.

doc/source/examples/diffractionobjectsexample.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Diffraction Objects Example
66
###########################
77

88
This example will demonstrate how to use the ``DiffractionObject`` class in the
9-
``diffpy.utils.scattering_objects.diffraction_objects`` module to process and analyze diffraction data.
9+
``diffpy.utils.diffraction_objects`` module to process and analyze diffraction data.
1010

1111
1) Assuming we have created a ``DiffractionObject`` called my_diffraction_pattern from a measured diffraction pattern,
1212
and we have specified the wavelength (see Section ??, to be added),
@@ -20,7 +20,7 @@ This example will demonstrate how to use the ``DiffractionObject`` class in the
2020
To load the converted array, you can either call ``test.q_to_tth()`` or ``test.on_q[0]``. ::
2121

2222
# Example: convert tth to q
23-
from diffpy.utils.scattering_objects.diffraction_objects import DiffractionObject
23+
from diffpy.utils.diffraction_objects import DiffractionObject
2424
my_diffraction_pattern.on_tth = [[0, 30, 60, 90, 120, 180], [1, 2, 3, 4, 5, 6]]
2525
my_diffraction_pattern.tth_to_q()
2626

doc/source/utilities/diffractionobjectsutility.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Diffraction Objects Utility
44
===========================
55

6-
The ``diffpy.utils.scattering_objects.diffraction_objects`` module provides functions
6+
The ``diffpy.utils.diffraction_objects`` module provides functions
77
for managing and analyzing diffraction data, including angle-space conversions
88
and interactions between diffraction data.
99

tests/diffpy/utils/test_diffraction_objects.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import pytest
55
from freezegun import freeze_time
66

7-
from diffpy.utils.scattering_objects.diffraction_objects import DiffractionObject
7+
from diffpy.utils.diffraction_objects import DiffractionObject
88
from diffpy.utils.transforms import wavelength_warning_emsg
99

1010
params = [

0 commit comments

Comments
 (0)