[sage-devel] Re: Docstring Formatting Question: Bullet Points

2022-08-12 Thread Kwankyu Lee
As a fruit of this discussion, I made https://trac.sagemath.org/ticket/34348 Please review. -- 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..

[sage-devel] Re: Docstring Formatting Question: Bullet Points

2022-07-15 Thread 'Travis Scrimshaw' via sage-devel
I don't think we should mandate things so much, but it would be good to have a general policy about this. For example, we have a policy about error messages, but this is not absolute. In particular, this is about breaking ties when an author is doing something that a reviewer dislikes. I don't

[sage-devel] Re: Docstring Formatting Question: Bullet Points

2022-07-12 Thread Kwankyu Lee
On Wednesday, July 13, 2022 at 12:13:28 PM UTC+9 John H Palmieri wrote: > I am "no" to having a Sage policy dictating blank lines, and I am also > "no" to having a policy dictating no blank lines. > We do have conventions in the developer manual by which sage developers are "dictated". Specifi

[sage-devel] Re: Docstring Formatting Question: Bullet Points

2022-07-12 Thread John H Palmieri
I am "no" to having a Sage policy dictating blank lines, and I am also "no" to having a policy dictating no blank lines. As Kwankyu Lee points out, sometimes a blank line is useful, sometimes it isn't. We should leave it up to the judgment of each individual developer. On Tuesday, July 12, 202

[sage-devel] Re: Docstring Formatting Question: Bullet Points

2022-07-12 Thread Kwankyu Lee
Bullet points are used in sage mainly in two places: (1) AUTHORS section in the doc string of a file (2) INPUTS section in the doc string of a class or function definition In (1), we usually look from the top to the bottom. This list may get longer and longer. So no blank line between points se

Re: [sage-devel] Re: Docstring Formatting Question: Bullet Points

2022-07-11 Thread David Lowry-Duda
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 n

[sage-devel] Re: Docstring Formatting Question: Bullet Points

2022-07-11 Thread Matthias Koeppe
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. On Monday, July 11