Skip to content

Commit 86838de

Browse files
committed
Remove methods in docstring
1 parent dca3e23 commit 86838de

File tree

2 files changed

+9
-26
lines changed

2 files changed

+9
-26
lines changed

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,12 @@ diffpy.utils.scattering_objects.diffraction_objects module
2626
:members:
2727
:undoc-members:
2828
:show-inheritance:
29+
30+
31+
diffpy.utils.scattering_objects.diffraction_object module
32+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33+
34+
.. automodule:: diffpy.utils.scattering_objects.diffraction_object
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:

src/diffpy/utils/scattering_objects/diffraction_object.py

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -45,32 +45,6 @@ class DiffractionObject:
4545
A list containing two numpy arrays: [d-spacing values, Intensities].
4646
metadata : dict
4747
Dictionary containing additional metadata about the diffraction data.
48-
49-
Methods
50-
-------
51-
set_angles_from_list(angles_list)
52-
Set the angular data for the experiment from a predefined list of angles.
53-
set_qs_from_range(begin_q, end_q, step_size=None, n_steps=None)
54-
Define Q values linearly spaced within the specified range. If step_size is provided,
55-
n_steps is ignored.
56-
set_angles_from_range(begin_angle, end_angle, step_size=None, n_steps=None)
57-
Define angle values linearly spaced within the specified range. If step_size is provided,
58-
n_steps is ignored.
59-
insert_scattering_quantity(xarray, yarray, xtype, metadata=None, scat_quantity=None, name=None,
60-
wavelength=None)
61-
Insert a new scattering quantity into the object with optional metadata. Additional optional
62-
parameters include scat_quantity, name, and wavelength.
63-
q_to_tth()
64-
Convert Q values to two-theta angles using the specified wavelength.
65-
tth_to_q()
66-
Convert two-theta angles to Q values using the specified wavelength.
67-
scale_to(target_diff_object, xtype=None, xvalue=None)
68-
Return a new diffraction object with rescaled intensity values.
69-
on_xtype(xtype)
70-
Return the data arrays associated with a given x-type (Q, two-theta, or d-spacing).
71-
dump(filepath, xtype=None)
72-
Save the data to a specified file, allowing selection of the data type to be saved.
73-
xtype defaults to 'q' if not specified.
7448
"""
7549

7650
def __init__(self, name="", wavelength=None):

0 commit comments

Comments
 (0)