Re: [sage-devel] Poll for issue G4 a specific guideline for writing docstrings

2017-05-17 Thread Eric Gourgoulhon
+1 for Daniel's proposal: G4. An OUTPUT block is recommended unless it is clear from the one-line > explanation. If in doubt include it. > > > -- You received this message because you are subscribed to the Google Groups "sage-devel" group. To unsubscribe from this group and stop receiving

Re: [sage-devel] Poll for issue G4 a specific guideline for writing docstrings

2017-05-17 Thread Bruno Grenet
+1 Le 17/05/2017 à 17:02, Jeroen Demeyer a écrit : +1 In practice, this is already how things are done anyway. -- 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

Re: [sage-devel] Poll for issue G4 a specific guideline for writing docstrings

2017-05-17 Thread Jeroen Demeyer
+1 In practice, this is already how things are done anyway. -- 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 post to

Re: [sage-devel] Poll for issue G4 a specific guideline for writing docstrings

2017-05-17 Thread Daniel Krenn
On 2017-05-17 16:24, Kwankyu Lee wrote: > We do a poll for adopting an official guideline for docstrings > (see https://trac.sagemath.org/ticket/23017 > ) > > G4. OUTPUT block is optional > > The developer manual says OUTPUT block is not

Re: [sage-devel] Poll for issue G4 a specific guideline for writing docstrings

2017-05-17 Thread Vincent Delecroix
On 17/05/2017 16:24, Kwankyu Lee wrote: We do a poll for adopting an official guideline for docstrings (see https://trac.sagemath.org/ticket/23017) G4. OUTPUT block is optional The developer manual says OUTPUT block is not optional. But I think the first statement of the

[sage-devel] Poll for issue G4 a specific guideline for writing docstrings

2017-05-17 Thread Kwankyu Lee
We do a poll for adopting an official guideline for docstrings (see https://trac.sagemath.org/ticket/23017) G4. OUTPUT block is optional The developer manual says OUTPUT block is not optional. But I think the first statement of the docstring "Return an object ..." already