Docs: Fix the overindentation of lists #5915
Conversation
sphuber
force-pushed
the
fix/docs-enumeration-indentation
branch
from
9ee3e26
to
6379fd3
Compare
There were a considerable number of bulleted and enumerated lists whose line markers were indented. This would cause them to be rendered as an indented code block. Instead, the lists should be indented to exactly the same level as the preceding text paragraph.
sphuber
force-pushed
the
fix/docs-enumeration-indentation
branch
2 times, most recently
from
fd8aad5
to
c315064
Compare
sphuber
force-pushed
the
fix/docs-enumeration-indentation
branch
from
c315064
to
2f063c7
Compare
There was a problem hiding this comment.
Thanks @sphuber, just one minor request. All changes looks good.
I am wondering why we don't use any pre-commit hook for reStructuredText? I find there are some such as https://github.com/peterjc/flake8-rst-docstrings, can we adopt it in aiida-core?
docs/source/howto/data.rst
Outdated
| * 'db_name': The name of the external database. | ||
| * 'db_uri': The base URI of the external database. | ||
| * 'uri': The exact URI of where the data can be retrieved. Ideally this is a persistent URI. | ||
| * 'id': The external ID with which the data is identified in the external database. | ||
| * 'version': The version of the data, if any. | ||
| * 'extras': Optional dictionary with other fields for source description. | ||
| * 'source_md5': MD5 checksum of the data. | ||
| * 'description': Human-readable free form description of the data's source. | ||
| * 'license': A string with the type of license that applies to the data, if any. |
There was a problem hiding this comment.
Since you are already here. I don't think single quotes are needed here as the name of the keys.
There was a problem hiding this comment.
You want me to change them to backticks to make them inline code, or just remove the quotes entirely? Think backticks would be good, right?
There was a problem hiding this comment.
I have no preference, to be honest, I think just removing the quotes is clear enough.
There was a problem hiding this comment.
Had another look and since they are keys in the database, I think double backticks are more appropriate.
This would be only for the docstrings of the code though, wouldn't it? It wouldn't lint the docs. Anyway, I would be in favor of this, but maybe just use |
I see, thanks. But not related to this PR anyway. |
sphuber
force-pushed
the
fix/docs-enumeration-indentation
branch
from
2f063c7
to
f0ed217
Compare
There were a considerable number of bulleted and enumerated lists whose line markers were indented. This would cause them to be rendered as an indented code block. Instead, the lists should be indented to exactly the same level as the preceding text paragraph.