Missing basic documentation for DOF and other elements
Summary
As reported by Michele, the documentation for the dof
command, including syntax guidance, example usage, and documentation of related commands such as Model.dofs
, is negligible at the moment.
A quick check shows the element descriptions for the following elements have the same lack of basic syntax description (i.e. lacking a description even of the required and optional arguments), which should be quick to fix:
-
Sources > Noise -
Readouts > DC readout -
Readouts > RF photodetector readout -
Control and Filtering > degree of freedom -
Control and Filtering > amplifier -
Control and Filtering > butter filter -
Control and Filtering > cheby filter
API pages such as finesse.components.dof.DegreeOfFreedom.html should similarly be expanded to a similar level to finesse.knm.maps.Map.html
We should add an example(s) showing usage of these controls-themed elements.
Steps to reproduce
Searching https://finesse.ifosim.org/docs/develop for "dof" returns results with mostly empty headings.