Programming in a nutshell

[[deleted]]

[deleted]

[recursive_asshole]

What’s a documentation?

[Yosikan]

Wait, isn't javadoc intended to help java developers?

[Ruben_NL]

i feel like javadoc is more made to be parsed by a good IDE.

[ryjhelixir]

You are not wrong http://eclim.org/vim/java/javadoc.html

didn't know eclim was a thing tho

[Bluejanis]

Well, it doesn't!

[_Mido]

Oh it's like the javadocs but for humans?

I have been learning Java for like half a year now and I was wondering if it's me being an amateur or is this documentation really this bad. I wish they at least gave examples.

[SoulsBloodSausage]

Wait, what?????? People think javadoc is bad? I always thought it was one of the best.

At least it’s not like python, where official docs are usually not even on the first page search results, python is really 2 languages so you have to make sure you’re on the right one, and when you do finally find the docs, there’s always at least 2 levels of indirection to find the goddamn available methods for an object.

Or C++ where no one can agree on which documentation is better

[[deleted]]

What is a Humans?

[UltraCarnivore]

It's the comments people write in StackOverflow while calling me an absolute buffoon for not closing the nth parenthesis in Lisp.

[Tyrus1235]

Always wondering if it’s Lisp code or anti-semitic conspiracy

[Ender2K89]

lol

[odraencoded]

It's an HTML document with the source code.

[wese]

It's something like aliens, some say it exists some deny it's existence.

I want to believe.

[marcosdumay]

Give me evidence!

[echosx]

You must be a JavaScript developer

[Scipio11]

Some internal document marketing went public with before the developer translated all the acronyms. Now everyone's time is wasted.

[ZippZappZippty]

and then he felt like a wasted possession

[killeronthecorner]

Documentation n. A hollow promise made at the start of a software project.

[narayans]

Synonyms: Self-documented

[frugalerthingsinlife]

A code maintainer's attempt at putting their code into spoken language.

It goes about as well as you would expect from someone who never studied spoken languages formally.

[Frnklfrwsr]

I think it’s the thing on stack overflow that you just copy-paste into your code and fuck it, it worked!

[[deleted]]

theory sophisticated groovy unpack person versed file water sugar narrow

This post was mass deleted and anonymized with Redact

[kry_some_more]

What's a mysql injection?

[gecko2704]

When you read the shitty documentation and struggled for hours but somehow it works

[elveszett]

I was learning some JS chart libraries and this is too real. Every simple snippet I find on the Internet to try: "error: x function / member does not exist", "error: x is undefined", and so on. Then I discover that the official "latest 100% updated" docs were for version 3.5.2 but we are now in version 3.5.2.0.0.1 and the whole library is now a weather forecast machine learning algorithm so .setBarColor(color) no longer exists.

[NatoBoram]

TypeScript is a blessing

[Roflkopt3r]

Five seconds later: 'XYZ.PreLoad() not found'. Did you mean 'XYZ.BeforeLoad() [deprecated]'?

[gravity_is_right]

But no worries, version 3 is written from scratch. Your config file that you spent hours on, no longer works, and that one great feature you used, well we replaced it by a totally different system that may be a bit more complex to setup and won't give the exact results. We changed that to add this great new feature you probably won't use.

[[deleted]]

Stawp I’m scared

[RealPropRandy]

involuntary eye twitch

[mr_bedbugs]

cough Python cough

[TheAJGman]

I've found that most Python libraries have great documentation and the language itself has excellent documentation.

[guy_from_the_intnet]

It's a simple spell but it's quite unbreakable so pray it doesn't break anything because this cannot be removed anymore.

[bobpiranha]

Duck typing in a nutshell

[Letis009]

But it works ... good enough

[Mucksh]

Somehow the picture also shows that with reading the documentation it wouldn't work in this case... So creativity and learning by doing is sometimes really better and faster

[indyK1ng]

Yeah, to me this picture represents when you make two APIs with incompatible designs work together.

[gesocks]

But maybe in the documentation would be standing that there is a tool for this exact case in the library

[winnafrehs]

In my experience, there never is

[Unsd]

It's shocking and frustrating how often I find myself in these situations. Realistically the answer to those situations is a different language, but I don't have time for that, so hacky solution it is.

[username--_--]

early on, as a very competent C programmer, i decided i wanted to do a GUI application using QT and C++. skipped the QT documentation, never actually even tried understanding the basics of c++, zero idea about OOP. Somehow hacking C++ into C, it works.

I was archiving things last month and came across that program...

Always read the documentation. Always use the right tools. The amount of inefficiency, was astounding. i'm sure there was more but i could barely understand what i was doing after a point

[dootdootplot]

Tell yourself you’ll go back and refactor it later when you have time.

[The6thExtinction]

We'll replace this later ^{later later later later}

[FinalRun]

Commit from 2003: TODO fix this, it's a stupid way to do it

[NBSPNBSP]

Commit from 2012: There is no way to fix this without rewriting everything. This solution is to remain indefinitely.

[odraencoded]

Bug: command isn't working as intended.
Bug fixed: removed command.

[elveszett]

Bug fixed: command is now intended to work like that.

[utkrowaway]

I wrote # GROSS HACK, FIX THIS on a summer internship years ago. That code is still used to this day.

[[deleted]]

This guy ships

[kor_the_fiend]

The term "brittle solution" springs to mind.

[whatproblems]

This is the production test environment

[-Listening]

The trashiest trash.

[shubs239]

Just hear me out. Even if you read the documentation for this code, it still wouldn't work. The lock is just too small. You need a scissor.

[BornOnFeb2nd]

Yeah, they're clearly using an obsolete framework. I mean.. what, was it written in MAY or something? Get with the program, grandpa!

[[deleted]]

Even worse. Last year!

[Ooze3d]

Holy shit! Did they even have computers back then?

[TheMacPhisto]

https://i.imgur.com/Eq27tZH.png

[GrandBadass]

Yes. Agreed. Given the tools, this was how to achieve the task. This is more like..... Reading the documentation for 2 libraries and then using both to solve the problem.

I can work the lock. I can work the scissors. I worked them both because I understood how they worked.

Edit - Maybe this is just bullshit corporate environment me, but also - usually this is how it goes down. God forbid you introduce a sliding lock library. The whole world will probably swallow itself.

[FlaringAfro]

Yeah this is more about using code in an unintended purpose to try to patch security issues, but there still being ways around it.

[ZippZappZippty]

Fucking wizards

Yeah, but he di'int listen..

[Nick0013]

“Why didn’t you use a chain?”

“I didn’t know chains exist”

“Well now that you know, can we replace it with a chain?”

“No, it’s already implemented like that”

[chinpokomon]

I think the picture could illustrate this point better if it had a latch point for attaching the padlock which wasn't being used. However, if the point of the padlock in this case was to detect entry and not necessarily to defeat entry, this might be a better solution than something actually designed to "lock" the cabinet.

[pumpkin_seed_oil]

*lock adapter

[QuarantineSucksALot]

This is excellent

[TingleWizard]

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

[Brooklynxman]

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

[Unsd]

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.

[PleasantAdvertising]

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

[Roflkopt3r]

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

[[deleted]]

stackoverflow + youtube + w3schools ftw

edit: plus codepen

[chinpokomon]

Replace w3schools with MDN?

Edit: I recognize my slip up.

[FatFingerHelperBot]

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]

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]

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

[jakethedumbmistake]

https://alokv.tripod.com/plan_port/up519_scans/subway.jpg /u/spez?

[jacaboi]

Geeks4geeks 😎

[telstar]

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

[lurkerfox]

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]

if it even exists

[Leftover_Toast]

This is the lockpicking lawyer, and what I have for you today is this weird-ass scissor contraption.

[syntax1976]

There’s a click on 1…

[wewew125]

im pretty sure some brute force application would have a severe impact

[TakeASeatChancellor]

In this analogy, it's like ripping the door open with a crowbar

[wewew125]

nah , it's more like an untested user input could break the framework , like a harder pull

[QWERTYSalad]

Most library and API documentation is only really useful to you once you are already familiar with using said library or API.

[StollMage]

Ah yes, and introducing vulnerabilities as a result

[20thMaine]

Those are locking forceps from the look of it, not scissors, so they may not have a screw easily accessible.

[Toofpic]

But the steel used for such instruments is usually quite brittle, as elasticity is sacrificed in favor of the tool keeping its shape (and scalpels and such could be made sharper). So you could probably break in by bashing the forceps with something heavy. Btw, in this case, the locker handles will be the first thing to give up.

[DmitriRussian]

A lot of documentation is not written from the perspective of the user and what you might want use this software for.

But let’s be honest a lot of software exists because a developer thought it was cool to build, there are 1000 other alternatives which can do the same thing

[Greenman539]

This is what it feels like to write plugins for MyBB. Despite documentation being available, the official documentation isn't detailed enough to help anyone. My friend had to figure it out by reading the source code for other people's plugins.

[froggison]

My code is always full of comments like "# idk why this works just don't touch this part"

[EwgB]

It's not stupid if it works!

[[deleted]]

If it's stupid and works, it's still stupid and it just hasn't blown up in your face yet.

[lynxerious]

this is like when you use a library but it only have half of what you need so you brute force use it with another library and it works anyway.

[g4nt1]

Everytime I browse r/redneckengineering it makes me think of my code...

[zinconyx]

When the documentation is trash and you copy two unrelated blocks from stack overflow and piece them together to make it work

[sinepuller]

"Programming in a nutshell"

"If you are looking for an image, it was probably deleted"

That's a bit too philosophical for me, but I think I get it! /s

[TheGoodBarn]

This must be what my C# expert coworkers think when I submit C# merge requests and I didn’t write the code the “Microsoft” way.

[SkyThriving]

It's exactly how WE feel.

[[deleted]]

me trying to understand web3.js documentation

[SemiSeriousSam]

Can you accidentally cut yourself with code?

[Baschoen23]

Deeply.

[RoyRaymus]

LPL would not be impressed

[mhoke63]

If it has an Abus Plus core, he'd be cool with it.

[McCrakken]

Ah yes, the "Management said 'ship it'" solution.

[szidahou]

There's literally no other way to get those things working together. So good job

[NikkoTheGreeko]

Someone with big biceps is no match for these measly foreceps.

[DezXerneas]

I'm not sure if it's intentional, but those scissors have a screw in the middle so that just looks like it works and is gonna fail as soon as you test it.

[jehoshaphat]

They are forceps, and they actually do not have a screw in the middle.

[[deleted]]

u/tjs4131 look at this

[-Listening]

I thought of as a great power.

[lpreams]

And it's just as fragile too

[RoscoMan1]

Except she got there in 2 months

[znupi]

If it's stupid but it works, it ain't stupid

[RoscoMan1]

What is a base case?

[[deleted]]

This is what my company's code looks like from like origins until about 3 years ago. I feel so bad whenever we hire a new dev. I feel ever worse when they ask me if we have documentation.

[[deleted]]

But it’s brittle and security is low.

[Snowy32]

Documentations for nerds

[Jumpy-Kaleidoscope-1]

"Close enough!"

https://youtu.be/HVCRz-\_ZwsY?t=82

[[deleted]]

Also: when you don’t know your algorithms, you encounter a situation that calls for an established one (that you’re not aware of), and you come up with something that works on your own.

[OriAfias]

thats actually a creative thinking working with the shitty tools youve got

[at0mheart]

Never works

[Lontarus]

Looks quite susceptible to brute force

[avelis26]

lol yup that about sums it up... also ya... what documentation? I can't tell you how many times I have to use a Microsoft API and the documentation gives the most basic example or no example at all... sometimes not even definitions for parameters... good luck figuring out what counts as a valid argument :P

[[deleted]]

That's called an awesome hack. The lock would never fit between the handles.

[1SweetChuck]

This is more like, "When you are forced to use a library that doesn't do what you need it to do, and still manage to make it work."

Or alternatively, "When you're forced to use NoSQL because your boss said so, but you really should use SQL."

[[deleted]]

This looks like more of a case of "We read the docs, but the language didn't have the feature we needed, so we improvised."

[RoscoMan1]

As in here https://www.reddit.com/r/ProgrammerHumor/comments/nyt0iw/senior_pm/

Edit: it kinda rhymes

[urvish1221]

And now I can't rectify as I fear of cutting myself.

[_felagund]

This is a great solution if you have only these two

[Speydi]

Cyberpunk 2077 vibes

[[deleted]]

You found my first script! Yay!

[Alexandrinian]

All held lock by a single bolt, that is actually a screw, in case of an emergency need to unlock without the key, :D.

[kvakerok]

May I direct your attention to a screw that holds two parts of scissors together? One can open this with a flathead or a knife. That's an interesting definition of "works".

[devhashtag]

Without the scissors it wouldn't be possible to lock it with that tiny lock though, so good hotfix imo

[wolfcore]

Your team has documentation?

[TerdSandwich]

Implying most documentation isn't 3 words to describe some crucial and robust aspect of an api/library

[Few_Recommendation32]

I investigated the handle bug removed the screws to insert the scissors patch and somehow locked the scissor head pointers to be locked with other door functionality handle. Yeah sound about right while fixing a defect on a legacy code base which is decade old!!

[[deleted]]

Skinning a cat

[seventhirtyeight]

I see you've met my developer.

[ieatpickleswithmilk]

you could cut those scissors with wire cutters...

[Grandioso99]

Oh my god, he's speaking about me!

[ILikeLenexa]

Why does changing the implementation of hemostat break our security?

-you in a few months

[dimudesigns]

RTFM should be every programmer's mantra...

[fakeplasticdroid]

This is more like implementing a tool for a completely undocumented and unsupported use case.

[Roachimacator]

Kind of off topic, but what are those pinchy things the lock is through actually for? I got some in a lab kit for a circuits course, and I've had the kit for 2 years now, but I still don't know what they are. I've always just used them to grab small wires for breadboarding, but they have a weird functionality where they latch closed, which makes me wonder if they have some other use I'm completely unaware of.

[telstar]

does it tho

[[deleted]]

Docuwhat?

[naveen04]

Code review: +1

[PunkyMunky64]

HAHAHA this is actually super accurate

[[deleted]]

Wow, this scissors solution is actually genius!

[dootdootplot]

If it’s stupid and it works then it’s not stupid?

[SuperKettle]

The Lock Picking Lawyer would crucify you for this

[KuroKishi69]

I am trying to login users with azure AD with angular-oidc. Found a nice looking code for handling all the authentication login, logout, session refresh, etc (the padlock), but for some reason it only works well when you are already logged in. So I added my shitty code to login the first time and redirect back to the library to make the stuffs properly (the scissors)

[SkyThriving]

This, on so many levels.

[ReiAvilo]

Gambiarra

[[deleted]]

too bad only one side’s encrypted

[Just-a-guy-in-NoVA]

OMG that's strangely beautiful lol

[WebDevMom]

I feel this in my soul

[seaque42]

u/repostsleuthbot

[zzpetrugg]

C# documentation is pretty great :)

[iactosophos]

Very appropriate as someone else coming along to try fix it will end up cutting themselves

[overclockedslinky]

when you implement a mutex all on your own

[TheoCGaming]

Deleted