this post was submitted on 24 Jun 2024
59 points (94.0% liked)

Programming

17419 readers
49 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Rules

  • Follow the programming.dev instance rules
  • Keep content related to programming in some way
  • If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities [email protected]

founded 1 year ago
MODERATORS
[email protected]
[email protected]
[email protected]
59
What is the deal with API documentation that can seem so terse to a hobbyist? (lemmy.world)
submitted 4 months ago by [email protected] to c/[email protected]
25 comments fedilink hide all child comments
 

I've encountered this many times where I simply don't understand the context and use of an API based of the API documentation unless I can find an example that already utilizes it in a working project. The first thing that comes to mind is Py Torch. I've tried to figure out how some API features work, or what they are doing in model loader code related to checkpoint caching but failed to contextualize. What harebrain details are obviously missing from someone who asks such a silly question?

you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 3 points 4 months ago (2 children)

Don’t change the documentation, change the code to make them line up.

Unless the documentation is wrong

[–] [email protected] 2 points 4 months ago* (last edited 4 months ago)

Just like malbolge

[–] [email protected] 1 points 4 months ago

Sure - but in the real world that mostly only happens when the documentation is an afterthought.