Python code should follow the Python Style Guide: PEP 8.
Documentation Strings should follow Python’s documentation style given in Chapter 7 of the Python Developer’s Guide. Use reStructuredText (reST) as extended by Sphinx.
The docstrings of
can serve as reference docstrings. Specifying an argument’s type is not necessary; if PEP 484
style type hints are used, Sphinx (through the
spinx_autodoc_typehints extension) will pick
them up automatically.
All python files should have the following modeline at the top:
# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4:
But modelines are a security risk, so put:
au FileType python setlocal tabstop=8 expandtab shiftwidth=4 softtabstop=4
in your .vimrc as well.
The ChimeraX git repository uses line ending normalization. On checkout, the majority
of files will have LF line endings. Use any editor in any configuration; line endings
in mixed files or CRLF files will be converted to LF on check-in except as specified
.gitattributes, which you may edit to protect any file that must have its
original line endings.
If you are comfortable, you can set
false in your
~/.gitconfig in order to ignore routine normalization warnings from
when using CRLF line endings on Windows.