Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Issues in docstrings #894

Open
fabcor-maxiv opened this issue Mar 19, 2024 · 4 comments
Open

Issues in docstrings #894

fabcor-maxiv opened this issue Mar 19, 2024 · 4 comments

Comments

@fabcor-maxiv
Copy link
Contributor

Building the documentation with sphinx-build lets Sphinx uncover a whole range of issues in docstrings. Those need to be fixed.
@fabcor-maxiv
Copy link
Contributor Author

fabcor-maxiv commented Mar 19, 2024 •
edited
Loading

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
Copy link
Contributor Author

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

@rhfogh
Copy link
Collaborator

rhfogh commented Mar 19, 2024

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
Copy link
Contributor

ok, on it

AnnieHeroux added a commit to AnnieHeroux/mxcubecore that referenced this issue Mar 20, 2024
@AnnieHeroux
to address the issue mxcube#894. Most of the fix is just adding a ne…
8498825 
…w line in the docstrings
@AnnieHeroux AnnieHeroux mentioned this issue Mar 20, 2024
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@rhfogh @fabcor-maxiv @AnnieHeroux