documenting properties about paramak HOT 4 CLOSED

@billingsley-john does it mean that properties shouldn't be documented at the class level anymore then ?

from paramak.

In another project I've added doc strings to these attributes setters using the @Property
https://github.com/ukaea/neutronics_material_maker/blob/72763629cfc9941d6aa5068fe6b304dde2a04c93/neutronics_material_maker/material.py#L235-L286

And it shows up in the docs
https://neutronics-material-maker.readthedocs.io/en/latest/material.html#neutronics_material_maker.material.Material.fispact_material

from paramak.

@shimwell sorry, I realize I haven't explained correctly. Docstrings appear in the docs if they're added to the block starting with @Property, but they do not appear if they're added to the block starting with @points.setter (for example).

In shape.py, we have docstrings for points but they're added in @points.setter part rather than the @Property part
https://github.com/ukaea/paramak/blob/develop/paramak/shape.py#L157-L168.

This is also the same for other things such as stp_filename
https://github.com/ukaea/paramak/blob/develop/paramak/shape.py#L237-L251

I shall go through and re-organise the docstrings for these attributes so that they appear in the documentation.
I wanted to raise the issue so that everyone was aware how they have to be documented.

from paramak.

@billingsley-john does it mean that properties shouldn't be documented at the class level anymore then ?

I think we should still document properties/attributes, the docstrings just need to be in the correct place. In most scripts, they are already correct.

from paramak.