search

bluesky / hklpy

Diffractometer computation library with ophyd pseudopositioner support
https://blueskyproject.io/hklpy
BSD 3-Clause "New" or "Revised" License
4 stars 12 forks source link

max_forward_iterations not found in the online documentation #195

Closed prjemian closed 3 years ago

prjemian commented 3 years ago

The Diffractometer.max_forward_iterations attribute does not appear in the online documentation except for the source code view.

Thanks @ambarb for pointing this out!

prjemian commented 3 years ago

https://github.com/bluesky/hklpy/search?q=iterations

prjemian commented 3 years ago

note:

(bluesky_2021_2) prjemian@zap:~/.../Bluesky/hklpy$ git grep max_forward_iterations 
hkl/diffract.py:    max_forward_iterations = Cpt(Signal, value=100, kind="config")
hkl/diffract.py:            start=self.position, end=pseudo, max_iters=self.max_forward_iterations.get()
hkl/tests/test_tardis.py:    assert tardis.max_forward_iterations.get() == 100
hkl/tests/test_tardis.py:    tardis.max_forward_iterations.put(500)  # increase from the default
prjemian commented 3 years ago

https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html?highlight=docstring#docstring-preprocessing

prjemian commented 3 years ago

This turned out to be much easier to resolve than using autoattribute.