Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ambiguity in the Structure section. #454

Open
rshipp opened this issue Jun 17, 2014 · 3 comments
Open

Ambiguity in the Structure section. #454

rshipp opened this issue Jun 17, 2014 · 3 comments

Comments

@rshipp
Copy link
Contributor

rshipp commented Jun 17, 2014

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?

@outkaj
Copy link

outkaj commented Mar 23, 2015

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.

@userlerueda
Copy link
Contributor

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?

@outkaj
Copy link

outkaj commented Feb 10, 2017

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants