kitzeslab / opensoundscape

Open source, scalable software for the analysis of bioacoustic recordings
http://opensoundscape.org
MIT License
136 stars 15 forks source link

use docstrings to document class attributes #1007

Open sammlapp opened 4 months ago

sammlapp commented 4 months ago

VS Code and other editors provide a helpful hover-over message displaying a docstring that is defined beneath an attribute's assignment. Adding these to our code for the core user-facing classes will improve usability.

Example (from a feature branch that may not ever be merged):

image