Re: [sage-devel] Second round poll for H5 a specific guideline for writing docstrings

2017-05-22 Thread Kwankyu Lee
On Monday, May 22, 2017 at 2:41:17 PM UTC+2, vdelecroix wrote: > > > Yes! A function in Python always return a unique object. This object > might be a tuple or a list with several components. Ok. Now I understand how you view things. I always thought it is a common idiom in Python that when

Re: [sage-devel] Second round poll for H5 a specific guideline for writing docstrings

2017-05-22 Thread Vincent Delecroix
On 22/05/2017 14:35, Kwankyu Lee wrote: It seems that some misunderstanding is going on here. If a method returns an integer and a matrix by "Return n, m". I am saying that the output block can be simply OUTPUT: - integer ... - matrix ... instead of OUTPUT: a tuple of ``(n,m)`` where - ``n

Re: [sage-devel] Second round poll for H5 a specific guideline for writing docstrings

2017-05-22 Thread Kwankyu Lee
It seems that some misunderstanding is going on here. If a method returns an integer and a matrix by "Return n, m". I am saying that the output block can be simply OUTPUT: - integer ... - matrix ... instead of OUTPUT: a tuple of ``(n,m)`` where - ``n`` is a integer ... - ``m`` is a matrix

Re: [sage-devel] Second round poll for H5 a specific guideline for writing docstrings

2017-05-22 Thread Jori Mäntysalo
On Mon, 22 May 2017, Daniel Krenn wrote: My opinion is that the phrase "a tuple `(a,b,c)` where ..." is just redundant. I think that "a tuple" is important non-redundant information. +1 for "a tuple" in this case (and not skipping this information; it is essential) +1 from me too. Somethin

Re: [sage-devel] Second round poll for H5 a specific guideline for writing docstrings

2017-05-22 Thread Daniel Krenn
On 2017-05-22 12:08, Jeroen Demeyer wrote: > On 2017-05-22 12:05, Kwankyu Lee wrote: >> My opinion is that the phrase "a tuple `(a,b,c)` where ..." is just >> redundant. > > I think that "a tuple" is important non-redundant information. +1 for "a tuple" in this case (and not skipping this informa

Re: [sage-devel] Second round poll for H5 a specific guideline for writing docstrings

2017-05-22 Thread Jeroen Demeyer
On 2017-05-22 12:21, Kwankyu Lee wrote: The non-redundant information will be implied by the list of hyphened items, if we stick to the convention. So, in order to understand the docstring, the user needs to read the docstring and the convention on how to read the docstring. Not good! -- You

Re: [sage-devel] Second round poll for H5 a specific guideline for writing docstrings

2017-05-22 Thread Kwankyu Lee
On Monday, May 22, 2017 at 12:08:35 PM UTC+2, Jeroen Demeyer wrote: > > On 2017-05-22 12:05, Kwankyu Lee wrote: > > My opinion is that the phrase "a tuple `(a,b,c)` where ..." is just > > redundant. > > I think that "a tuple" is important non-redundant information. > The non-redundant inform

Re: [sage-devel] Second round poll for H5 a specific guideline for writing docstrings

2017-05-22 Thread Jeroen Demeyer
On 2017-05-22 12:05, Kwankyu Lee wrote: My opinion is that the phrase "a tuple `(a,b,c)` where ..." is just redundant. I think that "a tuple" is important non-redundant information. -- You received this message because you are subscribed to the Google Groups "sage-devel" group. To unsubscribe

Re: [sage-devel] Second round poll for H5 a specific guideline for writing docstrings

2017-05-22 Thread Jeroen Demeyer
On 2017-05-22 12:05, Kwankyu Lee wrote: This is ugly. By your previous opinion, wouldn't you prefer this? | OUTPUT:a tuple of ``(a,b,c)``where -``a``is... -``b``is... -``c``is... | I think that the guideline of this thread combined with your one-liner style for OUTPUT allows this. Of cours

Re: [sage-devel] Second round poll for H5 a specific guideline for writing docstrings

2017-05-22 Thread Kwankyu Lee
On Monday, May 22, 2017 at 10:24:32 AM UTC+2, Jeroen Demeyer wrote: > > I very much object to this: > > > If the output consists > > of several items, add each starting with a hyphen. > > If the output consists of several items, the OUTPUT string should > clearly mention that fact (and it sho

Re: [sage-devel] Second round poll for H5 a specific guideline for writing docstrings

2017-05-22 Thread Jeroen Demeyer
I very much object to this: If the output consists of several items, add each starting with a hyphen. If the output consists of several items, the OUTPUT string should clearly mention that fact (and it should mention whether the output is a tuple or list or some other structure with several

Re: [sage-devel] Second round poll for H5 a specific guideline for writing docstrings

2017-05-19 Thread Johan S . H . Rosenkilde
> As I mentioned on the other thread, since OUTPUT is not a list of things > (as opposed to INPUT), I would prefer > > OUTPUT: tuple of lattices +1 on this option (and hence -1 to the thread's suggestion). -- You received this message because you are subscribed to the Google Groups "sage-devel

Re: [sage-devel] Second round poll for H5 a specific guideline for writing docstrings

2017-05-19 Thread Daniel Krenn
On 2017-05-19 08:57, Jeroen Demeyer wrote: > As I mentioned on the other thread, since OUTPUT is not a list of things > (as opposed to INPUT), I would prefer > > OUTPUT: tuple of lattices +1 for this option -- You received this message because you are subscribed to the Google Groups "sage-deve

Re: [sage-devel] Second round poll for H5 a specific guideline for writing docstrings

2017-05-18 Thread Jeroen Demeyer
As I mentioned on the other thread, since OUTPUT is not a list of things (as opposed to INPUT), I would prefer OUTPUT: tuple of lattices -- You received this message because you are subscribed to the Google Groups "sage-devel" group. To unsubscribe from this group and stop receiving emails fro