[sage-devel] Re: Secondl round poll for H6 a specific guideline for writing docstrings

2017-05-19 Thread Travis Scrimshaw 


On Friday, May 19, 2017 at 4:32:58 AM UTC-5, Kwankyu Lee wrote:
>
> +1
>
> In English, I understand that "foo; bar" is used if "bar" gives additional 
> information about "foo" while "foo, bar"is used to list "foo" and "bar" on 
> equal level. But I am not a native speaker...
>

Actually, that probably means you are a better judge because you spent time 
actually studying the proper methods. With that being said, being a native 
speaker, this is a correct approach. Semicolons can also be used to 
separate list items, in particular when those list items themselves contain 
commas, or connect two sentences/ideas that could be separated by a period 
(full stop) but you want to build an association between them.

Best,
Travis

-- 
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 this group, send email to sage-devel@googlegroups.com.
Visit this group at https://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.

[sage-devel] Re: Secondl round poll for H6 a specific guideline for writing docstrings

2017-05-19 Thread Sébastien Labbé 


On Friday, May 19, 2017 at 8:55:13 AM UTC+2, Simon King wrote:
>
> Almost +1 
>
> Actually I thought this guideline has already been used, with 
> a minute difference: 
>- ``n`` -- integer (default 1), the number of repetitions 
>

+1

-- 
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 this group, send email to sage-devel@googlegroups.com.
Visit this group at https://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.

[sage-devel] Re: Secondl round poll for H6 a specific guideline for writing docstrings

2017-05-19 Thread Kwankyu Lee 
+1

In English, I understand that "foo; bar" is used if "bar" gives additional 
information about "foo" while "foo, bar"is used to list "foo" and "bar" on 
equal level. But I am not a native speaker...

-- 
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 this group, send email to sage-devel@googlegroups.com.
Visit this group at https://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.

Re: [sage-devel] Re: Secondl round poll for H6 a specific guideline for writing docstrings

2017-05-19 Thread Erik Bray 
On Fri, May 19, 2017 at 8:49 AM, Simon King  wrote:
> Almost +1
>
> Actually I thought this guideline has already been used, with
> a minute difference:
>- ``n`` -- integer (default 1), the number of repetitions
>
> (so, "default" instead of "default:" and ")," instead of ");",
> since "path connected" punctuation marks are better than disconnected
> ones.

I find this less readable, and also less correct in how the
punctuation is used, but this is entirely subjective.

+1 to the original proposal.

> Actually I slightly prefer the modification that I stated.
>
> Rationale for the suggested modification: In some languages such
> as French, there is a mandatory blank space before any disconnected
> punctuation mark ("foo ; bar", foo : bar", "foo ? bar" "foo ! bar").
> But we write English, where this additional blank space is considered
> a typo.
>
> Hence, a guideline that avoids disconnected puncuation marks whenever
> possible helps to avoid spelling errors.
>
> Best regards,
> Simon
>
> On 2017-05-18, Kwankyu Lee  wrote:
>> Hi,
>>
>> I prepared H6 from your comments on the style of INPUT block. It was hard
>> to make a compromise from your differing opinions and reach a proposal for
>> the better. So this time* if I fail to get approval from most of you, the
>> guideline will be simply discarded.*
>> **
>> H6. Write
>>
>> INPUT:
>>
>> - ``n`` -- integer (default: 1); the number of repetition
>>
>> 
>> If you agree, flag +1; if you don't, flag -1.
>>
>
> --
> 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 this group, send email to sage-devel@googlegroups.com.
> Visit this group at https://groups.google.com/group/sage-devel.
> For more options, visit https://groups.google.com/d/optout.

-- 
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 this group, send email to sage-devel@googlegroups.com.
Visit this group at https://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.

[sage-devel] Re: Secondl round poll for H6 a specific guideline for writing docstrings

2017-05-19 Thread Simon King 
Almost +1

Actually I thought this guideline has already been used, with
a minute difference:
   - ``n`` -- integer (default 1), the number of repetitions

(so, "default" instead of "default:" and ")," instead of ");",
since "path connected" punctuation marks are better than disconnected
ones.

Actually I slightly prefer the modification that I stated.

Rationale for the suggested modification: In some languages such
as French, there is a mandatory blank space before any disconnected
punctuation mark ("foo ; bar", foo : bar", "foo ? bar" "foo ! bar").
But we write English, where this additional blank space is considered
a typo.

Hence, a guideline that avoids disconnected puncuation marks whenever
possible helps to avoid spelling errors.

Best regards,
Simon

On 2017-05-18, Kwankyu Lee  wrote:
> Hi,
>
> I prepared H6 from your comments on the style of INPUT block. It was hard 
> to make a compromise from your differing opinions and reach a proposal for 
> the better. So this time* if I fail to get approval from most of you, the 
> guideline will be simply discarded.*  
> **
> H6. Write
>
> INPUT: 
>
> - ``n`` -- integer (default: 1); the number of repetition
>
> 
> If you agree, flag +1; if you don't, flag -1.
>

-- 
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 this group, send email to sage-devel@googlegroups.com.
Visit this group at https://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.

[sage-devel] Re: Secondl round poll for H6 a specific guideline for writing docstrings

2017-05-18 Thread Travis Scrimshaw 
+1 (this is also my preferred format)

On Thursday, May 18, 2017 at 5:28:54 PM UTC-5, Kwankyu Lee wrote:
>
> Hi,
>
> I prepared H6 from your comments on the style of INPUT block. It was hard 
> to make a compromise from your differing opinions and reach a proposal for 
> the better. So this time* if I fail to get approval from most of you, the 
> guideline will be simply discarded.*  
> **
> H6. Write
>
> INPUT: 
>
> - ``n`` -- integer (default: 1); the number of repetition
>
> 
> If you agree, flag +1; if you don't, flag -1.
>

-- 
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 this group, send email to sage-devel@googlegroups.com.
Visit this group at https://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.