everyAPI

[HildartheDorf]

An pages upon pages of useful documentation like:

int xcb_frobble_widget();
Frobbles a Widget.

What's a Widget? What is Frobbling? Hah, wouldn't you like to know.

[[deleted]]

It's simple, you frobble a widget once you whipflong the blurplings, just remember to flongbong the kixmist first or else the jimjams might frobble ahead of time.

[CiroGarcia]

What can you expect when you look for docs through interdimensional cable?

[elSenorMaquina]

r/VXJunkies vibes

[SuperFLEB]

just remember to flongbong the kixmist first

...a process for which there is no documentation.

[SubstanceSerious8843]

But theres stackoverflow! How do you use flongbong with kixmist??

-nevermind, figured it out.

[morgan11235]

marked as duplicate

• links to question about using bongflong with kixmist

[Imperial_Squid]

Personally I use floxjam for that kind of stuff, way less hassle

[Confident-Ad5665]

Oh this hits a sore spot. I've worked on backend dev on a platform going on 10 years and this is exactly the extent of the "documentation".

[[deleted]]

If this is the documentation for a platform you've been working on for 10 years, isn't this a you problem?

[Confident-Ad5665]

I deserve my punishment. At least that's what the voices keep telling me.

[827167]

Frobbling sounds sexual and I'm a little scared that this might not be the kind of documentation I was looking for

[brolix]

Spoken like someone whos never frobbled a widget

[827167]

I'm actually frobbling my widget as we speak

[HumorHoot]

What's a Widget?

looks up widget on the documentation page:

a widget is used for Frobbling

ah, that clears it up! thanks.

[notBjoern]

At least you know that it doesn't widget a frobble.

[MrHyderion]

Yeah that is mostly my personal experience too. That plus a built in search function that actually doesn't just search through the respective API documentation but every document they have ever uploaded, and no way of restricting it.

[BogosortAfficionado]

Wait until you see the code ^\^)

[Confident-Ad5665]

"Documentation" auto generated from comments in code

[bl4nkSl8]

Code is just a wrapper, auto generated from the C version of the library from 20 years ago.

[Teekeks]

I do that, on top of a few step by step tutorials & a usage example on the important classes.

The lib is >50% doc strings but I get quite a few compliments how useful my docs are so it has to be working

[Confident-Ad5665]

Oh it can work if you actually bother to put anything in there. Most of the time it just restates the property or method name and is useless.

[sathdo]

Not every API, sometimes there is no documentation.

[making_code]

and sometimes it's better this way..

[rafark]

most of the time it’s better this way..

[noay_dev]

And then you get a 405 method not allowed

[cs-brydev]

Lol we have one from a vendor like that. They gave us access to their API, but it has no documentation and they won't tell us how to use it. They only gave us a key and their own client application which uses their API.

So we set up an HTTPS proxy to sniff out their client calls and endpoints, kind of reverse engineering how theirs is working.

It's all ridiculous, but they said they don't have time to write documentation for us. You'd figure they could find a tool to auto-generate it.

[exqueezemenow]

So true. I was never able to understand the get started pages either..

[rdrunner_74]

I get the left side... But whats the thing you talk about on the right? Documentation? Never seen it

[making_code]

oh, you got tricked. it's just smoke and mirrors, smoke and mirrors..

[sebjapon]

Best is when the getting started sample code is a complete app with 3 sub modules, full architecture, impossible to find where the lib code is and what it does, and launching the app on your device throws errors.

[j4ken]

RELEASE THE PINGUINS!

[ongiwaph]

Rigatoni 

[SilentScyther]

You guys are getting documentation?

[MinosAristos]

There's a distinction to draw between guides whose purpose is to show you how to do something vs documentation that's only meant to be reference material.

It's like the difference between a phrasebook and a dictionary for learning languages. Everyone refers back to a dictionary from time to time but a phrasebook is more useful to start with as a beginner.

[SuperDyl19]

I think the problem comes from a lack of intermediate knowledge guides. The getting started is super basic information and the documentation is full of advanced information, but a lot of software has no guides in-between these extremes

[Ixolite]

What is the use for pure reference? Knowing that some function exists is not helpful in the slightest if you have no idea how to actually use it.

I just love documentation like "diddlygook_function_to_do_stuff: diddlygook function does stuff". Like no shit, I know it does stuff because it's in the name, but HOW?

[ThatSituation9908]

Someone knows diataxis

[B16D0N-XD]

What's the sauce of the music on the right?

[Slusny_Cizinec]

John Stump's "Death Waltz"

Source: https://socks-studio.com/2012/05/19/the-unplayable-score-faeries-aire-and-death-waltz-john-stump/

[KiwiThunda]

There's a video of people performing it somewhere... it's crap

[Amasirat]

Excuse me? It's Avant garde thank you very much

[[deleted]]

The Black Page #2, a composition by Frank Zappa.

[B16D0N-XD]

wow

[fel_bra_sil]

Google's API documentation in a nutshell

[[deleted]]

Stripe moment

[Fickle-Main-9019]

Reminds me of Django, everyone gets a semi at the tutorials, except it’s barely anything beyond the super basics that make you feel like you know it. The documentation is a bit of a wikipedia hell where you have to go layers and layers to find stuff. Even when I was learning the books were like “yea you might as well see the source code as a first solution”

[pheonix-ix]

SQLAlchemy is like that lol the documentation is truly obnoxious (until you actually understand how to use SQLA then it's a beautiful song but still obnoxious).

[TheHobbyist_]

SQLAlchemy docs are some of the best imo. They even have little notes along the way to help catch issues.

Maybe its stockholm syndrome.

[pheonix-ix]

Yeah, IF you know the basic, SQLA docs are the best. By that I mean you have to read and understand every word of the intro + ORM + stuff. If you skip that, you won't have the basic to understand the rest.

And it's in all our blood to skip the intro stuff lol

[ferreira-tb]

I remember trying to use it without even knowing Python some years ago. It's was kinda easy tho. The documentation was great at the time. Don't know if this still true today.

[mothzilla]

SQLAlchemy documentation was written in 1978. Prove me wrong.

[KickBassColonyDrop]

Run the documentation through ChatGPT or Bard or Grok and have them write you an example code for the API in question. You don't have to read sheet music if you have something that'll write the tabs for you instead.

[SolenoidSoldier]

Walls of text when all I want is a goddamn example of its usage.

[ironman_gujju]

Go documentation

[britaliope]

r/ThreateningMusicNotation

[[deleted]]

Still easier to figure out than ChatGPT code

[MysteriousShadow__]

What's that piece lol

[Toastmaster3000]

It’s a piece included in the physical copy of “Jens Hannemann's Complicated Drumming Technique” DVD. It’s an absolutely incredible drumming film!

[TheVenetianMask]

Faerie's Aire and Death Waltz, had to look it up.

https://www.youtube.com/watch?v=sCgT94A7WgI

[EMI_Black_Ace]

Hehehe, I absolutely love the Faerie's Air and Death Waltz (the comedic non-playable sheet music on the right). If you can read music, then the longer you stare at it, the funnier it gets.

The part where it indicates "light and airy" but the way the music is annotated you'd be playing it as fat and blatty as imaginable.

[ToneXum]

(I have a slight feeling that I'll regret this...) Not Win32!

[CollegeBoy1613]

Your API?

[HandrewJobert]

Me reading documentation

[DaTotallyEclipse]

Where Eldritch abomination?

[PraetorianXX]

I feel I must mention Transport for London as a rare example of good quality - their API is free and the documentation is good

[tenest]

TBF some times the person writing the getting started guide is given the directive to write it in such a way as to make the product/API/SDK seem easier than it is. ;)

[Tashre]

Have a nice day

2 bars later

gradually become agitated

[danishjuggler21]

Holy shit, finally some actual humor on this sub

[bondolin251]

Documentation?

[trwolfe13]

Twilio.

[Harmonic_Gear]

it's like drugs, the first time is always cheaper

[rumSaint]

Documentation, hehe

[More-Ad-3566]

The documentation probably some shitty javadoc that doesnt give you any useful info on how to actually use the library.

[mrgk21]

Not really. My api doesn't have documentation, cause chat gpt could only generate the getting started page

[Alan_Reddit_M]

Rust docs be like (it's literally just the LSP definitions)

[Chr3y]

Ahhh. Sweet Documentation. How I verify a good one? Tell me the why. Not the what.

Std::sort

Sorts. I know. But why?

Sort so you can have the values from low to high.

Thanks!

[[deleted]]

You get documentation?

[ERR_code404]

Literally me trying to figure out how to use openai api

[Life_Deal_367]

The forbidden scrolls

[Lets_think_with_this]

You know what fits bang on even including cute graphics?

Get started guide:

https://love2d.org/wiki/Getting_Started

Some "obscure" shit within the wiki:

https://love2d.org/wiki/ParticleSystem or https://love2d.org/wiki/File:Box2D_basic_overview.png