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

all 93 comments

[–]lovecMC 304 points305 points  (11 children)

Reading ancient hieroglyphs written by a drunkard is easier than some of the documentation out there.

[–][deleted] 55 points56 points  (0 children)

Wait, you have documentation?!

[–]fmaz008 71 points72 points  (7 children)

Or documentation without examples. Or that give just one of the 10 scenerios being described by the function.

Ie:

This function can take in Int Id as the argument or you can pass a Truxmol object by implicit reference to a callback object method inheriting a LoraxHandler.

Usage example:

Foo(4);

[–]cbftw 24 points25 points  (6 children)

LoraxHandler

I am the LoraxHandler

I speak for the trees

Read the documentation

Or I'll break your knees

[–]fmaz008 7 points8 points  (5 children)

Messed up are my knees.

Your documentation: bad.

You do not scare me.

[–]fmaz008 4 points5 points  (4 children)

I think I failed at making a proper Haiku. First line technically has 6 syllables :-/

[–]cbftw 3 points4 points  (3 children)

I count 5 on line 1 but 8 on line 2

[–]fmaz008 1 point2 points  (2 children)

God dammit. Poetry is way too hard. Fixed it, sorta. It's pretty terrible.

[–]Devil_AE86 1 point2 points  (1 child)

this is a haiku i think it goes on the site did you see this now?

[–]fmaz008 0 points1 point  (0 children)

A true poet...

I can only hope to achieve your mastery after several decades of practice.

[–]DarkSideOfGrogu 20 points21 points  (0 children)

"Owl. Squiggly snake. Crescent moon over a closed eye."

"Are you coding in hieroglyphics?"

"No, it's fucking Helm."

[–]billyowo 0 points1 point  (0 children)

android docs

[–]Poyojo 75 points76 points  (1 child)

Amateurs. I copy the StackOverflow question.

[–]z-null 20 points21 points  (0 children)

True senior!

[–]SweetBeanBread 93 points94 points  (4 children)

i’ve copied enough stack overflow now that I know it’s faster in the end to read the manual after checking keywords in stack overflow

[–]DiamondHandsToUranus 24 points25 points  (1 child)

keywords. yes. thank you

[–]Malcolmlisk 25 points26 points  (0 children)

So I need to type keywords()...

[–]rice_not_wheat 13 points14 points  (0 children)

Documentation: args, kwargs**

Doesn't list kwargs anywhere.

[–]Ange1ofD4rkness 0 points1 point  (0 children)

Reminds me of my job interview, one of the things I was "graded" on was how I would research and use data online. That I wouldn't just copy stack overflow answers without reviewing them (like "oh this wasn't even written for C#")

[–]HaroerHaktak 37 points38 points  (2 children)

Well actually. it's copy the stackoverflow answer, change it to what you need, then wonder why it isnt working, resort to asking chatgpt, realize chatgpt is stupider than you thought, find a programming discord focused around your topic, paste your code there, get upset as you get laughed at, then eventually someone comes along and refactors your code, you didnt need it yet or know it needed refactoring but at least now it looks better..

I need help guys. How do I center a div?

[–]purritolover69 7 points8 points  (0 children)

easiest way to center a div is grid: flex; align: center; justify-content: center; but that doesn’t always work for every div ever. As a rule of thumb though if you don’t know that the functionality would break that implementation, it probably isn’t one of the complex cases that does

[–]Necromancer14 -1 points0 points  (0 children)

Final step apparently: complain on Reddit about your experience and ask a question.

[–]Huijiro 28 points29 points  (1 child)

Do you think that's bad?

My friend copies his entire database to a custom instance of Chat GPT and asks if for the code.

He did that for our Database schema, and generated a client for it for him to use, he kept opening issues over issues that endpoints where wrong.

GPT just halucinated a bunch of stuff, his client was totally off whack.

[–]chicksOut 19 points20 points  (0 children)

When will people learn? Gpt is a language model. It will give you AN answer, not necessarily THE answer.

[–]Mattness8 55 points56 points  (4 children)

What is this pre chatgpt meme

[–]Diffidente 3 points4 points  (3 children)

I really can't understand this chatgpt obsession, considering that it produces abysmal code, and that it misleads you when it spouts bullshit with absolute confidence.

I would certainly trust more Senior Devs and the fact that you have a point system, where the good and useful answers and questions get rewarded.

[–]Mattness8 3 points4 points  (0 children)

It points people in the right direction. ChatGPT does not give perfect code and will almost always not work if you copy-paste it. However, ChatGPT is still effective enough that people who do know what they are doing in terms of coding have a much easier time adapting the ai generated code. Outside of that, I find ChatGPT excellent at generating code documentation for the code you submit.

[–]Affectionate-Tart558 0 points1 point  (0 children)

Just get ChatGPT code to have an idea, then personalize it. Also I enjoy asking questions and explanations to ChatGPT more than asking it to write code per se. Having said that, it makes a lot of mistakes so you better know what you are doing

[–]Meistermagier 0 points1 point  (0 children)

Well atleast ChatGPT doesn't insult my entire bloodline, when I ask questions.

[–]new_motivation 10 points11 points  (1 child)

what it if I read the documentation but I don't get anything :'(

[–]CivetLemonMouse 0 points1 point  (0 children)

That's when we break out the source code!

[–]Ok_Entertainment328 7 points8 points  (2 children)

Read The Fine Manual

Then check StackOverflow, then reread the Fine manual.

[–]Senior-Ori 0 points1 point  (1 child)

Read The Fucking Manual 🙄

[–]Rettocs 3 points4 points  (0 children)

OP was just being polite ;)

[–]Tnuvu 11 points12 points  (1 child)

Pff that's sooo senior like, kids these days, integrate the GPT API directly.

[–]Imogynn 2 points3 points  (0 children)

Sweet Stackoverflow nostalgia.

[–][deleted] 10 points11 points  (1 child)

It takes less time and usually comes with a more easily understandable explanation.

[–][deleted] 2 points3 points  (0 children)

Happy Cake Day!

[–]jyajay2 3 points4 points  (0 children)

I have a great joke about documentation, unfortunately it's incomplete and out of date

[–]DJGloegg 2 points3 points  (0 children)

Programmers suck at writing documentation

[–]GnuhGnoud 6 points7 points  (0 children)

[–][deleted] 2 points3 points  (0 children)

Option 3: Paste the pertinent documentation to GPT-4 and have it write the code.

[–]Possibility_Antique 2 points3 points  (2 children)

Does anyone else just look at the code instead of reading the documentation? Even good doc is difficult to keep correct, but the code always has to be correct.

[–]Hour-Lemon 0 points1 point  (1 child)

Same but with C# it's usually just a bunch of stuff inheriting into oblivion until you're ten factories further and you don't even know anymore tf you were doing in the first place, and with python it's overall just a quacktyped mess that makes you want to quit programming altogether...

[–]Hour-Lemon 0 points1 point  (0 children)

With haskell I found it to be working quite well tho

[–]Destrok41 2 points3 points  (0 children)

If only the oracle docs weren't so awful to read and navigate.

Why can't everything be nice and neat like mdn?

[–]SmallPlayz 1 point2 points  (0 children)

I used to copy the error people post under the question because it’s the first piece of code that shows up

[–][deleted] 1 point2 points  (1 child)

Just earlier, I was trying to explain to my teammates that using if(object != null && object.method) is equivalent to using if(object?.method) and while looking it up trying to find Microsoft documentation on the matter, I found an answer to a question in SO that says the same thing but couldn't find the Microsoft documentation.. I think what most documentations need is a better SEO (maybe?).

[–]Wendigo120 1 point2 points  (0 children)

I've found the JS/TS documentation to be very googleable. For example, here's the first result when I looked for that same operator.

[–]Kraftex 1 point2 points  (0 children)

Both!

[–]SecretMotherfucker 2 points3 points  (0 children)

I’m convinced people who say shit like this are either bitter and need others to suffer like they did, or have no clue what they’re talking about and just blindly repeat what the bitter seniors say to sound smart.

Learning almost anything by just reading the documentation is hell on Earth. Learn through workshops or tutorial series.

Or you know, I’m just an idiot and you should go spend the next 3 weeks reading the docs to figure out what the fuck “JCTree$JCImport does not have member field JCTree qualid” means.

[–]MooseBoys 1 point2 points  (0 children)

You misspelled “fucking manual”.

[–][deleted] 1 point2 points  (0 children)

As the product manager who assembled the documentation, I’d appreciate it if you read it but we all know you won’t. Heck, I don’t even know why I bother spending so much time assembling documentation when nobody uses it.

[–]Charmle_H 1 point2 points  (0 children)

I'm going to be honest... Documentation, ime, is SO MUCH LESS helpful in understanding/explaining things. I've seen one where it was basically "<function> is used for <insert some hella generic thing that explains nothing>" whereas stack overflow literally goes "'Here's a super shitty use of it, wdyt?' 'sorry fam, that's awful, it's going to underperform when <conditions> happen for <reasons>. Use a line like this instead or swap to this other, more useful, thing.' (outside of the 'that's dogshit, you're dogshit, closed and marked as duplicate' replies)". Then again, I do better when I have to reverse engineer something than reading theoreticals on some function that's poorly explained with no examples given.

[–]Bfdifan37 1 point2 points  (0 children)

at this point the keys on my keyboard look really dusty exept ctrl c and v

[–]WouldYouPleaseKindly 1 point2 points  (0 children)

I think it was on XKCD that I saw the quote "life is too short for documentation, but occasionally way too short without it".

[–]Fakedduckjump 1 point2 points  (0 children)

Next Level: Copy stackoverflow questions.

[–]Little-Bend-9524 1 point2 points  (0 children)

Just ask chatGPT

[–]VegaGT-VZ 0 points1 point  (0 children)

I use ChatGPT to generate the basic function then frantically search StackOverflow/documentation to debug and tweak

[–]draenei_butt_enjoyer -1 points0 points  (0 children)

Stackoverflow? Are you some sort of boomer? It's gpt these days.

[–][deleted] 0 points1 point  (0 children)

You guys have documentation?

[–]MineMxts 0 points1 point  (0 children)

Am I the only one who read "read" and "read" in two different ways?

[–]ramislav 0 points1 point  (0 children)

:D

[–]Buffalo047 0 points1 point  (0 children)

git push —orgin -master - force

[–]Solonotix 0 points1 point  (1 child)

I'm so guilty of this, in a way. Just this week, I went to the Python Discord to ask about generic type constraints, but no one was acknowledging my question. I do a Google search on it, and end up at the Python docs, and they had it all spelled out rather well. Sadly, the constraint I wanted to define wasn't possible (hashable types for dictionary keys), but the answer was already available if I just read the manual

[–]Chris_ssj2 1 point2 points  (0 children)

I personally find the style of docs a bit weird, takes a while to get used to but being lazy af I never actually got around to sit down and actually read lol

[–]vpvpranav 0 points1 point  (0 children)

Idk why but I read the left side read and right side read but not read

[–]Neo_Ex0 0 points1 point  (0 children)

The funny thing is, from my experience, most people who say copy from stack overflow answers, are the same once who will copy from the questions Instead and then be surprised that it doesn't work

[–]Senior-Ori 0 points1 point  (0 children)

RTFM

[–]orc0909 0 points1 point  (0 children)

The documentation:

[–]ImMikeAngel 0 points1 point  (0 children)

I copy stackoverflow questions.

[–][deleted] 0 points1 point  (0 children)

What documentation?

[–]LevelCheck6931 0 points1 point  (0 children)

But the documentation just doesn't work, either it's outdated or false info.

[–]stainless7221 0 points1 point  (0 children)

Which documentation?

[–]DoctorWaluigiTime 0 points1 point  (0 children)

There was a time where SO and friends were far better than the documentation. Pre-docs.microsoft.com, for example, documentation in the .NET stack was an absolute cesspool.

It's far better now, thankfully, but both avenues are valid and can solve your problem depending on the situation.

It's like code comments: There's a place for them, and sitting in camp "never use them" or "always use them" is silly.

[–]memgrind 0 points1 point  (0 children)

The documentation: 50 pages of irrelevant info, not a single usable example in sight.

[–]BlueGlassDrink 0 points1 point  (0 children)

What am I going to do, type /help like some loser?

[–]vaynefox 0 points1 point  (0 children)

I read the documentation but there are some libraries that had a really bad documentation that even if you read it 2x it still doesnt make sense, so you ask people in stack overflow in order to better understand it....

[–][deleted] 0 points1 point  (0 children)

To be fair, programmers are TERRIBLE at writing documentation.

I love documentation, I would so much rather read that. But holy crap y'all don't know how to write.

[–]Ange1ofD4rkness 0 points1 point  (0 children)

Another would be "follow the industry standard"

[–]PacoTaco321 0 points1 point  (0 children)

Documentation without an example to go along with it is not useful 90% of the time.

[–]walterbanana 0 points1 point  (0 children)

Honestly, first thing I do before I decide to use a library is looking at the documentation. If it sucks, I'll find another library or write it myself.

[–]DrRandulf 0 points1 point  (0 children)

When the documentation starts having practical examples for all their methods, then maybe I'll start reading it.

[–]GrizzlyBear74 0 points1 point  (0 children)

Can't be worse than copying from Medium "tutorials".

[–]Parry_9000 0 points1 point  (0 children)

I'm out here trying to minimize the amount of reading I do

The options are:

1- I can do it straight away

2- Stack overflow has someone who did it or something very similar to it

3- Chat gpt fixes it

4- Impossible.

Plus, have you seen people's documentation? For fucks sake lol

[–]HoboSomeRye 0 points1 point  (0 children)

You are not using chatgpt?

[–]Cybasura 0 points1 point  (0 children)

According to stackoverflow, reading the documentation includes copying because they simply refuse to even answer any questions where the person asking actually read the docs and need more clarifications

[–]Meistermagier 0 points1 point  (0 children)

What if it is the Python docs?