python-guide icon indicating copy to clipboard operation
python-guide copied to clipboard

Ambiguity in the Structure section.

Open rshipp opened this issue 10 years ago • 3 comments

I'm a little confused as to what this passage from writing/structure means.

Readability means to avoid useless boilerplate text and clutter,
therefore some efforts are spent trying to achieve a certain level of brevity.
But terseness and obscurity are the limits where brevity should stop. 

Could this be reworded as something like this?

Readability in this case refers to avoiding useless boilerplate text and
clutter, and some effort has been made to achieve a certain level of brevity
in Python's syntax. However, there is a fine line between terseness and
obscurity.

I'm not sure I'm correctly grasping the meaning of the text. Does it actually mean something completely different?

rshipp avatar Jun 17 '14 17:06 rshipp

I think from your rewording that you have misunderstood the original meaning. I interpreted it like this: it's important to write concise code and avoid boilerplate and unnecessary wordiness. However, your code should not be so brief that it's unclear what it means, nor should it be short just for the sake of being short. Of course the original version expresses it more eloquently, but hopefully the interpretation I provided helped clarify what was meant.

outkaj avatar Mar 23 '15 18:03 outkaj

In my opinion at least the first part of the sentence may be reworded from:

Readability means to avoid useless boilerplate text and clutter

to:

Readability means avoiding useless boilerplate text and clutter

Thoughts?

userlerueda avatar Feb 09 '17 03:02 userlerueda

That makes sense. Also, going against my earlier comment, I think, @rshipp, that your re-wording is in fact a clearer way to express the point the author was trying to make.

outkaj avatar Feb 10 '17 02:02 outkaj