Add docstrings

[tlambert03]

this pulls annotations from the schema and renders them as numpy-style docstrings. for instance:

@ome_dataclass
class Objective(ManufacturerSpec):
    """A description of the microscope's objective lens.

    Required elements include the lens numerical aperture, and the
    magnification, both of which a floating point (real) numbers. The values
    are those that are fixed for a particular objective: either because it
    has been manufactured to this specification or the value has been
    measured on this particular objective. Correction: This is the type of
    correction coating applied to this lens. Immersion: This is the types of
    immersion medium the lens is designed to work with. It is not the same as
    'Medium' in ObjectiveRef (a single type) as here Immersion can have
    compound values like 'Multi'. LensNA: The numerical aperture of the lens
    (as a float) NominalMagnification: The specified magnification e.g. x10
    CalibratedMagnification: The measured magnification e.g. x10.3
    WorkingDistance: WorkingDistance of the lens.

    Parameters
    ----------
    annotation_ref : AnnotationRef, optional
    calibrated_magnification : float, optional
        The magnification of the lens as measured by a calibration process-
        i.e. '59.987' for a 60X lens.
    correction : Correction, optional
        The correction applied to the lens
    id : ObjectiveID
    immersion : Immersion, optional
        The immersion medium the lens is designed for
    iris : bool, optional
        Records whether or not the objective was fitted with an Iris.
    lens_na : float, optional
        The numerical aperture of the lens expressed as a floating point
        (real) number. Expected range 0.02 - 1.5
    lot_number : str, optional
        The lot number of the component.
    manufacturer : str, optional
        The manufacturer of the component.
    model : str, optional
        The Model of the component.
    nominal_magnification : float, optional
        The magnification of the lens as specified by the manufacturer - i.e.
        '60' is a 60X lens. Note: The type of this has been changed from int
        to float to allow the specification of additional lenses e.g. 0.5X
        lens
    serial_number : str, optional
        The serial number of the component.
    working_distance : float, optional
        The working distance of the lens expressed as a floating point (real)
        number. Units are set by WorkingDistanceUnit.
    working_distance_unit : UnitsLength, optional
        The units of the working distance - default:microns.
    """

    annotation_ref: List[AnnotationRef] = field(default_factory=list)
    calibrated_magnification: Optional[float] = None
    correction: Optional[Correction] = None
    id: ObjectiveID = AUTO_SEQUENCE  # type: ignore
    immersion: Optional[Immersion] = None
    iris: Optional[bool] = None
    lens_na: Optional[float] = None
    nominal_magnification: Optional[float] = None
    working_distance: Optional[float] = None
    working_distance_unit: Optional[UnitsLength] = UnitsLength("µm")

[codecov-commenter]

Codecov Report

Merging #40 into master will increase coverage by 0.27%.
The diff coverage is 98.08%.

@@            Coverage Diff             @@
##           master      #40      +/-   ##
==========================================
+ Coverage   95.20%   95.48%   +0.27%     
==========================================
  Files           1        1              
  Lines         396      509     +113     
==========================================
+ Hits          377      486     +109     
- Misses         19       23       +4     

Impacted Files	Coverage Δ
src/ome_autogen.py	95.48% <98.08%> (+0.27%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 90c1e3c...94f0c39. Read the comment docs.

[jmuhlich]

🤯