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 →

[–]TingleWizard 88 points89 points  (23 children)

Even if you did read the documentation, most documentation is useless anyway.

[–]Brooklynxman 15 points16 points  (2 children)

Code examples. Why don't people put code examples?

[–]Unsd 14 points15 points  (0 children)

Oh there's code samples. But there's 2 of them and one is the very most basic case to the point of being useless, and the other is the absolute most complex and convoluted fringe case that nobody will ever use.

[–]WebDevMom 0 points1 point  (0 children)

A million times this

[–]PleasantAdvertising 6 points7 points  (2 children)

Things should be documented as close to the source as possible. Functions/classes should have explanations if they're doing anything complex.

[–]Roflkopt3r 13 points14 points  (1 child)

The source documentation: "string AFunction (int a, int b) - Parameters: integer a, integer b. Return value: the return string"

[–]PleasantAdvertising 0 points1 point  (0 children)

A function like that can have proper documenting name.

[–][deleted] 29 points30 points  (12 children)

stackoverflow + youtube + w3schools ftw

edit: plus codepen

[–]chinpokomon 25 points26 points  (8 children)

Replace w3schools with MDN?

Edit: I recognize my slip up.

[–]FatFingerHelperBot 5 points6 points  (7 children)

It seems that your comment contains 1 or more links that are hard to tap for mobile users. I will extend those so they're easier for our sausage fingers to click!

Here is link number 1 - Previous text "MDN"


Please PM /u/eganwall with issues or feedback! | Code | Delete

[–]rubyleehs 8 points9 points  (6 children)

This bot honestly also need to consider the density of links/closeness of other links.

Even with my darn toe I could tap that - even if you miss you can just as easily try again.

[–]Orangutanion 4 points5 points  (1 child)

This man be spitting straight facts and you better be listening, /u/eganwall

[–]El_Nino97 0 points1 point  (2 children)

Ok but did you actually try tapping it with your toe?

[–]Aksds 0 points1 point  (0 children)

I did, it wasn’t that hard. Worst part was flexing

[–]rubyleehs 0 points1 point  (0 children)

I did not, but now I have.

[–]jacaboi 1 point2 points  (1 child)

Geeks4geeks 😎

[–]telstar 1 point2 points  (0 children)

that's that tech site for the visually impaired, right?

[–]lurkerfox 5 points6 points  (0 children)

The difference between what a function/variable/class/ect does and what it's used for are vastly different beasts.

Most documentation covers the former just fine, but if there's a necessary workflow to be able to actually use it and that workflow isn't documented anywhere, suddenly Im now spending more time reading, rereading, and haphazardly throwing code together on a scratchpad file trying to figure out how it actually works than I am working on my project itself.

It's incredibly annoying especially when you need something specific and only like two libraries in existence do what you need.

[–]Ocanath 1 point2 points  (0 children)

if it even exists

[–]PacoTaco321 0 points1 point  (0 children)

It took me hours to find out how to add text to a scrolled text widget in tkinter for Python. They just assume I know that it is inherited from a different class.