https://pantsbuild.org/ logo
#development
Title
# development
b

bored-art-40741

04/10/2021, 7:49 PM
Do we have a convention for documenting attributes in dataclasses? e.g. using a docstring after the attribute line, or just having an
__init__
-style docstring at the class level?
h

hundreds-father-404

04/10/2021, 8:09 PM
class docstring. If you have a custom init, then there
b

bored-art-40741

04/10/2021, 8:10 PM
sg
h

hundreds-father-404

04/10/2021, 8:11 PM
We haven't been disciplined doing the whole param thing for class docstring. It's kinda more prose style A big improvement we want to make to plugin API is to generate docs probably via Sphinx, so we'll eventually need to figure it out tho