On Monday, July 11, 2022 at 4:57:39 PM UTC-7 Travis Scrimshaw wrote:
Right now there are two conventions throughout Sage for bullet points (and
similar things). Someone has been systematically trying to change
everything to one convention (which I am opposed to). However, we as a
community have not had a discussion about this as far as I am aware (I
believe also changing the example doc page at some point). I figured we
should have this conversion now.
The question is this: Should there be blanklines between bullet
points?
I am content with continuing to allow both spaced lists with newlines
and tight lists without newlines. Sage follows sphinx here, and sphinx
follows rst (as in the spec [1]).
[1]:
https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#bullet-lists
On Mon, Jul 11, 2022 at 06:57:05PM -0700, Matthias Koeppe wrote:
In https://trac.sagemath.org/ticket/30448, I propose to add a linting tool
for our docstrings. I haven't checked whether it has an opinion on the
style question that you asked (I don't), but I have already found (and
fixed) some mistakes in the markup in some files using it.
I've used flake8-rst-docstrings before and it also allows both tight and
loose list syntax by default. I don't think there is a way to choose one
style over the other.
- DLD
--
You received this message because you are subscribed to the Google Groups
"sage-devel" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to sage-devel+unsubscr...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/sage-devel/Yszde1dU9tjFYA/J%40icerm-dld.
