![[ChimeraX Issue Tracking System]](/trac/ChimeraX/chrome/site/ChimeraX-icon.svg){kind=icon}
Opened 5 years ago
Closed 4 years ago
#4071 closed defect (fixed)
Sphinx doesn't like indentation of some code comments
| Reported by: | Tom Goddard | Owned by: | Eric Pettersen |
|---|---|---|---|
| Priority: | moderate | Milestone: | |
| Component: | Documentation | Version: | |
| Keywords: | Cc: | ||
| Blocked By: | Blocking: | ||
| Notify when closed: | Platform: | all | |
| Project: | ChimeraX |
Description
Make install in docs/devel is issuing warnings from Sphinx that indentation is not acceptable in list_info, some new JSON return value comments. Also some save_command comment it is unhappy with.
/Users/goddard/ucsf/chimerax/ChimeraX.app/Contents/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/chimerax/list_info/cmd.py:docstring of chimerax.list_info.cmd.info:19: WARNING: Unexpected indentation.
/Users/goddard/ucsf/chimerax/ChimeraX.app/Contents/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/chimerax/list_info/cmd.py:docstring of chimerax.list_info.cmd.info:20: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/goddard/ucsf/chimerax/ChimeraX.app/Contents/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/chimerax/list_info/cmd.py:docstring of chimerax.list_info.cmd.info:30: WARNING: Unexpected indentation.
/Users/goddard/ucsf/chimerax/ChimeraX.app/Contents/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/chimerax/list_info/cmd.py:docstring of chimerax.list_info.cmd.info_models:10: WARNING: Unexpected indentation.
/Users/goddard/ucsf/chimerax/ChimeraX.app/Contents/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/chimerax/list_info/cmd.py:docstring of chimerax.list_info.cmd.info_chains:8: WARNING: Unexpected indentation.
/Users/goddard/ucsf/chimerax/ChimeraX.app/Contents/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/chimerax/list_info/cmd.py:docstring of chimerax.list_info.cmd.info_chains:9: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/goddard/ucsf/chimerax/ChimeraX.app/Contents/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/chimerax/list_info/cmd.py:docstring of chimerax.list_info.cmd.info_chains:12: WARNING: Unexpected indentation.
/Users/goddard/ucsf/chimerax/ChimeraX.app/Contents/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/chimerax/list_info/cmd.py:docstring of chimerax.list_info.cmd.info_residues:9: WARNING: Unexpected indentation.
/Users/goddard/ucsf/chimerax/ChimeraX.app/Contents/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/chimerax/list_info/cmd.py:docstring of chimerax.list_info.cmd.info_distmat:6: WARNING: Unexpected indentation.
/Users/goddard/ucsf/chimerax/ChimeraX.app/Contents/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/chimerax/save_command/cmd.py:docstring of chimerax.save_command.cmd.provider_save:3: WARNING: Unexpected indentation.
Change History (2)
comment:1 by , 5 years ago
| Status: | assigned → accepted |
|---|
comment:2 by , 4 years ago
| Resolution: | → fixed |
|---|---|
| Status: | accepted → closed |
