1136
Solutions? Where we're going, we don't need solutions.
(lemmy.world)
Post funny things about programming here! (Or just rant about your favourite programming language.)
I can’t see what you’re referring to
Markdown seems to put it on one line, which has its own problems, but this is what it looks like in actual docs:
This is hardly even the worst offender; it gets worse as the number of internal class members goes up, since they all get listed out. This whole section should just be dropped in favor of simply listing the class name. Further down, there's a bulleted list of the params, which is what you actually want.
In fact, there's plenty more in that doc that could be fixed. For example:
Too many parameters on each line. Do this instead:
This also puts more whitespace around the key/value pairs, which gives your eyes more resting point. In general, erring on the side of additional whitespace around non-alphanum characters tends to improve readability.
This style can come into conflict with coding rules about max function length. The solution to that is to be flexible about max function length. I would rather see 40 simple lines than 10 with everything jammed up together.
Edit: interestingly, my Lemmy instance seems to handle syntax highlighting on the second
add_argument
example better than the first. That might just be the implementation, though; my vim setup seems to handle highlighting both equivalently.I can only see the picture you included, my instance * likely blocks ascii in favor of input cleaning sorry to be stuck a pain!
I have to be honest: I dont see the problem of including the entire signature at the top of the doc, and the listing the params below. If I know the class/function, a quick look at the signature is often all I need, so I find it convenient that it's at the top of the doc. If it's a class/function I'm not familiar with, I just scroll to the bullet points.
I agree on the bit about whitespace in signatures though. Luckily Python allows me to use as many lines as I want within a parentheses.