Skip to content

docs: some parts in documentation are incorrect. #352

@ycexiao

Description

@ycexiao

Problems

  • Failed example for DiffractionObject.get_array_index
  • Duplicate code block
  • Failed example for diffpy.utils.transform.d_to_tth
  • Markup not rendered correctlly

failed example for DiffractionObject.get_array_index

In Diffraction Objects Example documentation step 4

tth_ninety_index = diff_object1.get_array_index(90, xtype="tth")

will raise

TypeError: DiffractionObject.get_array_index() got multiple values for argument 'xtype'

Because the signature is

def get_array_index(self, xtype, value):
    ...

failed example for diffpy.utils.transform.d_to_tth

In https://www.diffpy.org/diffpy.utils/examples/transforms_example.html#id1, step 3

from diffpy.utils.transforms import d_to_tth

wavelength = 0.71
d = np.array([1.0, 0.8, 0.6, 0.4, 0.2])
tth = d_to_tth(d, wavelength)

will raise

ValueError: The supplied input array and wavelength will result in an impossible two-theta. Please check these values and re-instantiate the DiffractionObject with correct values. 

duplicate code block

In https://www.diffpy.org/diffpy.utils/examples/resample_example.html#resampling-example, step 1. The same code block and words appear twice. This might be a typo.


markup not rendered correctly

In https://www.diffpy.org/diffpy.utils/examples/parsers_example.html#id1, step 5. A sentence is included in a code block.

Proposed solution

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions