this post was submitted on 03 Aug 2023

490 points (99.4% liked)

Programmer Humor

19706 readers

241 users here now

Welcome to Programmer Humor!

This is a place where you can post jokes, memes, humor, etc. related to programming!

For sharing awful code theres also Programming Horror.

Rules

Keep content in english
No advertisements
Posts must be related to programming or programmer topics

founded 1 year ago

MODERATORS

490

Why is it so hard finding up-to-date docs and guides? (media.kbin.social)

submitted 1 year ago by [email protected] to c/programmer_humor

45 comments fedilink hide all child comments

you are viewing a single comment's thread
view the rest of the comments

[–] [email protected] 2 points 1 year ago

If using docstrings/docblocks to generate SDK documentation, adding something like an OPA policy to validate their existence and semantic structure could help with coverage. Then we have the issue of accuracy, and that needs humans or AI to weigh in. I have a feeling test-driven development would make this process smoother.

You could also add git hooks to facilitate accountability / run the policies.