cta-observatory / ctapipe

Low-level data processing pipeline software for CTAO or similar arrays of Imaging Atmospheric Cherenkov Telescopes
https://ctapipe.readthedocs.org
BSD 3-Clause "New" or "Revised" License
63 stars 267 forks source link

Docstrings of classes #2417

Open maxnoe opened 10 months ago

maxnoe commented 10 months ago

Describe the issue

We have duplicated and missing documentation of classes.

According to the numpy docstring guides (where it is less explicit) and examples in their codebases and also in the astropy codebase, class should be documented in their class docstring, not the docstring of __init__.