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

2017-05-22 Thread Sébastien Labbé
On Monday, May 22, 2017 at 10:27:28 AM UTC+2, Jeroen Demeyer wrote: > > > > The only thing I want to see in the OUTPUT > > block is > > the *type* of the objects and how many of them. > > Why that? What's wrong with being verbose in the OUTPUT block? > The OUTPUT block appearing below other,

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

2017-05-22 Thread Jeroen Demeyer
On 2017-05-22 11:35, Jori Mäntysalo wrote: Why that? What's wrong with being verbose in the OUTPUT block? This is a misquote. I meant to reply to Sébastien Labbé. -- You received this message because you are subscribed to the Google Groups "sage-devel" group. To unsubscribe from this group

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

2017-05-22 Thread Jori Mäntysalo
On Mon, 22 May 2017, Jeroen Demeyer wrote: On 2017-05-19 14:16, Jori Mäntysalo wrote: The only thing I want to see in the OUTPUT block is the *type* of the objects and how many of them. Why that? What's wrong with being verbose in the OUTPUT block? This is a misquote. I support something

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

2017-05-22 Thread Jeroen Demeyer
On 2017-05-19 14:16, Jori Mäntysalo wrote: The only thing I want to see in the OUTPUT block is the *type* of the objects and how many of them. Why that? What's wrong with being verbose in the OUTPUT block? I would like something like INPUT: - ``certificate`` -- boolean; whether to output a c

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

2017-05-19 Thread Michael Orlitzky
On 05/19/2017 02:55 AM, david.coud...@inria.fr wrote: > A method like `Graph().is_bipartite(certificate=False)` returns either > ``True``or ``False`` when ``certificate==False``, or a tuple `(bool, > dict)` when ``certificate==True``. What would be the recommended writing > style for the output blo

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

2017-05-19 Thread Jori Mäntysalo
On Fri, 19 May 2017, Sébastien Labbé wrote: My suggestion would be OUTPUT: - If ``certificate=True`` return only True or False. - If ``certificate=False`` return either    * (True, XX), where XX is...    * (False, XX), where XX is...   I think this is too mu

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

2017-05-19 Thread Sébastien Labbé
> > My suggestion would be > > OUTPUT: > > - If ``certificate=True`` return only True or False. > - If ``certificate=False`` return either >* (True, XX), where XX is... >* (False, XX), where XX is... > > > I think this is too much information which will overlap with the INPUT blo

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

2017-05-19 Thread Jori Mäntysalo
On Thu, 18 May 2017, david.coud...@inria.fr wrote: A method like `Graph().is_bipartite(certificate=False)` returns either ``True``or ``False`` when ``certificate==False``, or a tuple `(bool, dict)` when ``certificate==True``. What would be the recommended writing style for the output block ? M