Add numpy-style docstrings to all modules - #42
Conversation
Documentation build overview
7 files changed ·
|
|
Most of the modules are missing in RTD because RTD install pyaml core from pip and get version 0.2.5 which does not have a pyaml.validation module. All the module from tango.pyaml which import this can not build. Ideally we would need to release a version of pyaml to pip before building the doc for this package |
Every module, class and public method of tango.pyaml now carries a numpy-format docstring. Class docstrings include Parameters, Attributes and Methods sections, following the pyaml core style. Also fixes docstrings that no longer matched the code (TangoControlSystem parameters, StaticCatalog raises, TangoCatalog disconnected parameter). No code change: only docstrings were added or rewritten. Fixes #39 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AJzpQexixFAPP5hzc12inQ
I agree. It would also be nice to make a release of pyaml today so we have a couple of days to test that the release is working as expected since it includes many changes. We can then make more smaller releases next week if needed. I have prepared it but someone needs to approve: python-accelerator-middle-layer/pyaml#399 |
|
Yes we can try to do that today. |
2 participants
Fixes #39
Would be good to merge before the new release.
No code change: only docstrings were added or rewritten (using AI).
Every module, class and public method of tango.pyaml now carries a numpy-format docstring. Class docstrings include Parameters, Attributes and Methods sections, following the pyaml core style. Also fixes docstrings that no longer matched the code (TangoControlSystem parameters, StaticCatalog raises, TangoCatalog disconnected parameter).