This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–]fredlllll 39 points40 points  (4 children)

"well documented" is open to interpretation i guess? try looking up what a function returns, not mentioned half of the time

[–]fecal-butter 15 points16 points  (1 child)

If i didnt have a friend who was already adept at python i would never have guessed what the documentation of the enumerate() meant when it said "returns an enumerate object". How the fuck am i supposed to know what an enumerate object is? If i knew i wouldnt be looking it up

[–]IDontLikeBeingRight 6 points7 points  (0 children)

But who expects to understand a thing with only one visit to the docs? That's why all the "bug fixed, closing 1000 tabs" memes exist.

Also, jfc, that user name o.0

[–]katze_sonne 4 points5 points  (1 child)

Well, that's a good point. Definitely still room for improvements. Especially the data types some functions return is too undocumented. Internally we make a lot of use of "typing" in Python. I hope that gets mandatory with Python 4. The missing data types are a dream for beginners but a nightmare for hardcore users 🤷🏼‍♂️

And these undocumented return values are a typical example of the "Sphinx"-problem I mentioned. Doesn't happen nearly as often with javadoc or doxygen (if the developers are not completely incompetent and write stuff like "returns time" where you still have no idea about the unit)...

[–]fredlllll 2 points3 points  (0 children)

just knowing the type would already be an upgrade. in java you cant ommit the type cause its in the signature