search

mxcube / mxcubecore

Backend used by MXCuBE
http://mxcube.github.io/mxcube/
GNU Lesser General Public License v3.0
11 stars 51 forks source link

Issues in docstrings #894

Open fabcor-maxiv opened 3 months ago

fabcor-maxiv commented 3 months ago

Building the documentation with sphinx-build lets Sphinx uncover a whole range of issues in docstrings. Those need to be fixed.

fabcor-maxiv commented 3 months ago

Here is a bunch of examples:

HardwareObjects/ESRF/ESRFBeam.py:docstring of mxcubecore.HardwareObjects.ESRF.ESRFBeam.ESRFBeam.get_available_size:7: WARNING: Block quote ends without a blank line; unexpected unindent.
HardwareObjects/ESRF/ESRFBeam.py:docstring of mxcubecore.HardwareObjects.ESRF.ESRFBeam.ESRFBeam.set_value:3: ERROR: Unexpected indentation.
HardwareObjects/ESRF/ESRFBeam.py:docstring of mxcubecore.HardwareObjects.ESRF.ESRFBeam.ESRFBeam.set_value:4: WARNING: Block quote ends without a blank line; unexpected unindent.
HardwareObjects/ESRF/ESRFBeamlineActions.py:docstring of mxcubecore.HardwareObjects.ESRF.ESRFBeamlineActions:4: ERROR: Unexpected indentation.
HardwareObjects/ESRF/ESRFBeamlineActions.py:docstring of mxcubecore.HardwareObjects.ESRF.ESRFBeamlineActions:11: ERROR: Unexpected indentation.
HardwareObjects/ESRF/ESRFBeamlineActions.py:docstring of mxcubecore.HardwareObjects.ESRF.ESRFBeamlineActions:14: WARNING: Block quote ends without a blank line; unexpected unindent.
HardwareObjects/ESRF/ESRFBeamlineActions.py:docstring of mxcubecore.HardwareObjects.ESRF.ESRFBeamlineActions:16: ERROR: Unexpected indentation.
HardwareObjects/ESRF/ESRFBeamlineActions.py:docstring of mxcubecore.HardwareObjects.ESRF.ESRFBeamlineActions:17: WARNING: Block quote ends without a blank line; unexpected unindent.
HardwareObjects/ESRF/ESRFBeamlineActions.py:docstring of mxcubecore.HardwareObjects.ESRF.ESRFBeamlineActions:18: WARNING: Block quote ends without a blank line; unexpected unindent.
HardwareObjects/ESRF/ESRFPhotonFlux.py:docstring of mxcubecore.HardwareObjects.ESRF.ESRFPhotonFlux:4: ERROR: Unexpected indentation.
HardwareObjects/ESRF/ESRFPhotonFlux.py:docstring of mxcubecore.HardwareObjects.ESRF.ESRFPhotonFlux:9: WARNING: Block quote ends without a blank line; unexpected unindent.
HardwareObjects/ESRF/ESRFPhotonFlux.py:docstring of mxcubecore.HardwareObjects.ESRF.ESRFPhotonFlux.ESRFPhotonFlux.wait_for_beam:3: ERROR: Unexpected indentation.
HardwareObjects/ESRF/ESRFPhotonFlux.py:docstring of mxcubecore.HardwareObjects.ESRF.ESRFPhotonFlux.ESRFPhotonFlux.wait_for_beam:5: WARNING: Definition list ends without a blank line; unexpected unindent.
HardwareObjects/ESRF/ESRFPhotonFlux.py:docstring of mxcubecore.HardwareObjects.ESRF.ESRFPhotonFlux.ESRFPhotonFlux.wait_for_beam:6: WARNING: Block quote ends without a blank line; unexpected unindent.
HardwareObjects/ExporterNState.py:docstring of mxcubecore.HardwareObjects.ExporterNState:4: ERROR: Unexpected indentation.
HardwareObjects/ExporterNState.py:docstring of mxcubecore.HardwareObjects.ExporterNState:10: WARNING: Block quote ends without a blank line; unexpected unindent.
HardwareObjects/Gphl/GphlWorkflow.py:docstring of mxcubecore.HardwareObjects.Gphl.GphlWorkflow.GphlWorkflow.setup_data_collection:4: WARNING: Field list ends without a blank line; unexpected unindent.
HardwareObjects/LimaEigerDetector.py:docstring of mxcubecore.HardwareObjects.LimaEigerDetector.LimaEigerDetector.prepare_acquisition:4: ERROR: Unexpected indentation.
HardwareObjects/LimaEigerDetector.py:docstring of mxcubecore.HardwareObjects.LimaEigerDetector.LimaEigerDetector.prepare_acquisition:5: WARNING: Block quote ends without a blank line; unexpected unindent.
HardwareObjects/LimaEigerDetector.py:docstring of mxcubecore.HardwareObjects.LimaEigerDetector.LimaEigerDetector.prepare_acquisition:10: ERROR: Unexpected indentation.
HardwareObjects/LimaEigerDetector.py:docstring of mxcubecore.HardwareObjects.LimaEigerDetector.LimaEigerDetector.prepare_acquisition:12: WARNING: Definition list ends without a blank line; unexpected unindent.
HardwareObjects/LimaEigerDetector.py:docstring of mxcubecore.HardwareObjects.LimaEigerDetector.LimaEigerDetector.prepare_acquisition:14: ERROR: Unexpected indentation.
HardwareObjects/LimaEigerDetector.py:docstring of mxcubecore.HardwareObjects.LimaEigerDetector.LimaEigerDetector.prepare_acquisition:15: WARNING: Block quote ends without a blank line; unexpected unindent.
HardwareObjects/LimaEigerDetector.py:docstring of mxcubecore.HardwareObjects.LimaEigerDetector.LimaEigerDetector.prepare_acquisition:16: WARNING: Block quote ends without a blank line; unexpected unindent.
HardwareObjects/LimaEigerDetector.py:docstring of mxcubecore.HardwareObjects.LimaEigerDetector.LimaEigerDetector.prepare_acquisition:19: WARNING: Definition list ends without a blank line; unexpected unindent.
HardwareObjects/LimaEigerDetector.py:docstring of mxcubecore.HardwareObjects.LimaEigerDetector.LimaEigerDetector.prepare_acquisition:32: ERROR: Unexpected indentation.
HardwareObjects/LimaEigerDetector.py:docstring of mxcubecore.HardwareObjects.LimaEigerDetector.LimaEigerDetector.prepare_acquisition:33: WARNING: Block quote ends without a blank line; unexpected unindent.
HardwareObjects/MD3UP.py:docstring of mxcubecore.HardwareObjects.MD3UP.MD3UP.get_timeresolved_mesh_exptime:3: WARNING: Definition list ends without a blank line; unexpected unindent.
HardwareObjects/MD3UP.py:docstring of mxcubecore.HardwareObjects.MD3UP.MD3UP.get_timeresolved_mesh_nbframes:3: WARNING: Definition list ends without a blank line; unexpected unindent.
HardwareObjects/MD3UP.py:docstring of mxcubecore.HardwareObjects.MD3UP.MD3UP.timeresolved_mesh_scan:3: ERROR: Unexpected indentation.
HardwareObjects/MD3UP.py:docstring of mxcubecore.HardwareObjects.MD3UP.MD3UP.timeresolved_mesh_scan:4: WARNING: Block quote ends without a blank line; unexpected unindent.
HardwareObjects/Microdiff.py:docstring of mxcubecore.HardwareObjects.Microdiff.Microdiff.characterisation_scan:13: ERROR: Unexpected indentation.
HardwareObjects/Microdiff.py:docstring of mxcubecore.HardwareObjects.Microdiff.Microdiff.characterisation_scan:15: WARNING: Block quote ends without a blank line; unexpected unindent.
HardwareObjects/MicrodiffAperture.py:docstring of mxcubecore.HardwareObjects.MicrodiffAperture:8: ERROR: Unexpected indentation.
HardwareObjects/MicrodiffAperture.py:docstring of mxcubecore.HardwareObjects.MicrodiffAperture:17: WARNING: Block quote ends without a blank line; unexpected unindent.
HardwareObjects/MicrodiffLightBeamstop.py:docstring of mxcubecore.HardwareObjects.MicrodiffLightBeamstop:6: ERROR: Unexpected indentation.
HardwareObjects/MicrodiffLightBeamstop.py:docstring of mxcubecore.HardwareObjects.MicrodiffLightBeamstop:12: WARNING: Block quote ends without a blank line; unexpected unindent.
HardwareObjects/MicrodiffZoom.py:docstring of mxcubecore.HardwareObjects.MicrodiffZoom:5: ERROR: Unexpected indentation.
HardwareObjects/MicrodiffZoom.py:docstring of mxcubecore.HardwareObjects.MicrodiffZoom:11: WARNING: Block quote ends without a blank line; unexpected unindent.
model/queue_model_objects.py:docstring of mxcubecore.model.queue_model_objects.SampleCentring:11: ERROR: Unexpected indentation.
model/queue_model_objects.py:docstring of mxcubecore.model.queue_model_objects.create_interleave_sw:10: WARNING: Field list ends without a blank line; unexpected unindent.
model/queue_model_objects.py:docstring of mxcubecore.model.queue_model_objects.create_interleave_sw:21: ERROR: Unexpected indentation.
model/queue_model_objects.py:docstring of mxcubecore.model.queue_model_objects.to_collect_dict:7: ERROR: Unexpected indentation.
model/queue_model_objects.py:docstring of mxcubecore.model.queue_model_objects.to_collect_dict:9: WARNING: Block quote ends without a blank line; unexpected unindent.
model/queue_model_objects.py:docstring of mxcubecore.model.queue_model_objects.to_collect_dict:21: ERROR: Unexpected indentation.
model/queue_model_objects.py:docstring of mxcubecore.model.queue_model_objects.to_collect_dict:29: WARNING: Block quote ends without a blank line; unexpected unindent.
fabcor-maxiv commented 3 months ago

Would be nice if someone could go through those. Maybe @AnnieHeroux ?

rhfogh commented 3 months ago

Don't worry about the GPhL one - that is fixed in my XML/YAML PR (#868).

Anyway, the error messages are rather cryptic. In my case it was because the doc strings were not in Google format at all.

AnnieHeroux commented 3 months ago

ok, on it