[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-29 Thread Keara Berlin
Hi all, I didn't mean for there to be significant differences between what I posted here versus in the commit message. Sorry for any confusion around that! Thank you for putting them both in one place here - that is helpful. Take care, Keara On Sun, Jun 28, 2020, 16:12 Paul Sokolovsky wrote:

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-29 Thread Edwin Zimmerman
On 6/28/2020 4:10 PM, Giampaolo Rodola' wrote: > From: > https://github.com/python/peps/commit/0c6427dcec1e98ca0bd46a876a7219ee4a9347f4 > > > Instead of requiring that comments be written in Strunk & White Standard > > English, require instead that English-language comments be clear and easily

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-28 Thread Paul Sokolovsky
Hello, Shouldn't such feedback be also cross-posted to the python-dev mailing list? Also note the original pull request, https://github.com/python/peps/pull/1470, and differences of what was written in the pull request description and what went in the commit message. On Sun, 28 Jun 2020

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-28 Thread Giampaolo Rodola'
From: https://github.com/python/peps/commit/0c6427dcec1e98ca0bd46a876a7219ee4a9347f4 > Instead of requiring that comments be written in Strunk & White Standard English, require instead that English-language comments be clear and easily understandable by other English speakers. This accomplishes

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-28 Thread David Mertz
On Sun, Jun 28, 2020, 10:19 AM Jeff Allen > Now the commit message is the thing that causes me to write. It contains a long justification for the change. It need only have said that we've decided not to enforce S rules. It is somewhat offensive, since it asserts as fact an opinion the community

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-28 Thread MRAB
On 2020-06-28 13:25, Jeff Allen wrote: [snip] And the conclusion is right, but the argument is better than he makes it. I've no idea what a Weegie is, but Brum is just up the road from where I write, and I can tell you only about 60% of Brummies class themselves as white. A high proportion of

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-28 Thread Jeff Allen
On 27/06/2020 10:35, Stephen J. Turnbull wrote: Keara Berlin writes: > Here is the current line in PEP-8: "When writing English, follow > Strunk and White." I propose changing this line to "When writing > English, ensure that your comments are clear and easily > understandable to other

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-27 Thread Bernardo Sulzbach
On Sat, Jun 27, 2020 at 6:40 AM Stephen J. Turnbull < turnbull.stephen...@u.tsukuba.ac.jp> wrote: > Keara Berlin writes: > > I wouldn't object to > > When writing English, write clearly and understandably. Consider > your audience -- many readers of your comments in Python sources >

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-27 Thread Chris Angelico
On Sat, Jun 27, 2020 at 4:59 PM Steve Barnes wrote: > > Can I suggest an addition to this discussion that the phrase: "Must adhere to > python community guidelines" otherwise it is possible to be disrespectful, > abusive, sexist, etc., while being clean and understandable (and even > adhering

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-27 Thread Steve Barnes
Sent: 27 June 2020 07:09 To: python-ideas@python.org Subject: [Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments On 27/06/20 5:30 pm, David Mertz wrote: > My point is that _Elements of Style_ is not a se

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-27 Thread Greg Ewing
On 27/06/20 5:30 pm, David Mertz wrote: My point is that _Elements of Style_ is not a set of rules. It's a nice book with generally good advice; it's not a style guide in a formal sense. Also, does it actually say anything that would forbid or discourage use of terms such as "chocker" and

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-27 Thread Greg Ewing
On 27/06/20 4:33 pm, Steven D'Aprano wrote: Take the word out of the sentence, and does the sentence still mean the same thing? Then the word was needless. That's an objective test. But in something a fuzzy as natural language, "the same thing" is not a boolean value. How close in meaning does

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-26 Thread David Mertz
My point is that _Elements of Style_ is not a set of rules. It's a nice book with generally good advice; it's not a style guide in a formal sense. If we wanted rules, _The Chicago Manual of Style_ or the_Associated Press Style Guide_ would be much closer to that. But neither of those actually

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-26 Thread Steven D'Aprano
On Sat, Jun 27, 2020 at 12:37:35AM -0400, David Mertz wrote: > Objectively, could I have dropped "most"? Both "most famous"? > > Could you have dropped "still," objectively? Yes, we probably could have. What's your point? I'm not arguing in favour of S here on this mailing list, and I've

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-26 Thread Chris Angelico
On Sat, Jun 27, 2020 at 2:44 PM Soni L. wrote: > > > Take word out of sentence, does sentence still mean same? Then word > needless. Is objective test. That sounds like the way the Heavy Weapons Guy talks (when he speaks English - his native language is Russian). What you've done is make a

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-26 Thread Soni L.
On 2020-06-27 1:33 a.m., Steven D'Aprano wrote: On Fri, Jun 26, 2020 at 11:36:47PM -0400, David Mertz wrote: > On Fri, Jun 26, 2020, 8:40 PM Steven D'Aprano wrote: > > > "Clear and easily understandable" is subjective. What is clear and > > understandable to me may be impenetrably

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-26 Thread David Mertz
Objectively, could I have dropped "most"? Both "most famous"? Could you have dropped "still," objectively? On Sat, Jun 27, 2020, 12:34 AM Steven D'Aprano wrote: > On Fri, Jun 26, 2020 at 11:36:47PM -0400, David Mertz wrote: > > On Fri, Jun 26, 2020, 8:40 PM Steven D'Aprano > wrote: > > > > >

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-26 Thread Steven D'Aprano
On Fri, Jun 26, 2020 at 11:36:47PM -0400, David Mertz wrote: > On Fri, Jun 26, 2020, 8:40 PM Steven D'Aprano wrote: > > > "Clear and easily understandable" is subjective. What is clear and > > understandable to me may be impenetrably confusing to others, or > > obnoxiously dumbed down. > > > >

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-26 Thread David Mertz
On Fri, Jun 26, 2020, 8:40 PM Steven D'Aprano wrote: > "Clear and easily understandable" is subjective. What is clear and > understandable to me may be impenetrably confusing to others, or > obnoxiously dumbed down. > Strunk and White's most famous mandate of "omit needless words" is likewise

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-26 Thread Kyle Stanley
I can't say that I've ever assessed the quality of a code comment based on how well it adheres to Strunk & White, nor have I ever been involved with an environment that tries to strongly enforce that specific style of writing. So FWIW, I agree that "clear and concise English" is more relevant to

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-26 Thread Guido van Rossum
Steven just likes an argument. Nobody has ever taken the idea of a standard for language in comments seriously. It Just doen come up. On Fri, Jun 26, 2020 at 18:35 Bernardo Sulzbach < berna...@bernardosulzbach.com> wrote: > On Fri, Jun 26, 2020 at 9:43 PM Steven D'Aprano > wrote: > >> I dislike

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-26 Thread Bernardo Sulzbach
On Fri, Jun 26, 2020 at 9:43 PM Steven D'Aprano wrote: > I dislike Strunk and White, and don't follow it myself (except by > accident, as it were) but I've worked with neuro-atypical programmers > who found it really useful to have a common standard that they could > follow and reduce the

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-26 Thread Steven D'Aprano
On Fri, Jun 26, 2020 at 09:08:31PM -, Keara Berlin wrote: > Hi all, this is a very small change, but I thought I would field it > here to see if anyone has suggestions or ideas. Instead of requiring > that comments be written in Strunk & White Standard English, PEP-8 > should require

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-26 Thread Keara Berlin
Good idea - I'll submit that now. ___ Python-ideas mailing list -- python-ideas@python.org To unsubscribe send an email to python-ideas-le...@python.org https://mail.python.org/mailman3/lists/python-ideas.python.org/ Message archived at

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-26 Thread David Mertz
Your minor change is certainly an improvement. _The Elements of Style_ ( https://en.wikipedia.org/wiki/The_Elements_of_Style) is certainly a good text, but it's not even actually a style guide in the formal sense. On Fri, Jun 26, 2020 at 5:26 PM Keara Berlin wrote: > Hi all, this is a very

[Python-ideas] Re: Amend PEP-8 to require clear, understandable comments instead of Strunk & White Standard English comments

2020-06-26 Thread Gregory P. Smith
Given I've never even heard of Strunk & White (my own privilege i'd assume)... yeah. I don't actually know what the existing "When writing English, follow Strunk and White." text in PEP-8 even means. It doesn't hyperlink to an online source for English style probably because this was written so