Dear documentation writers,

It is of
no use if you don't tell me what happens in an edge case. What happens if I pass NULL? If I can't pass it, then tell me that I can't. Sheesh.

Sincerely,

:haggard:

Follow

@rq

The style of documentation that describes what the author of the library wants people to try to do using the library is sadly quite common.

Sign in to participate in the conversation
Qoto Mastodon

QOTO: Question Others to Teach Ourselves
An inclusive, Academic Freedom, instance
All cultures welcome.
Hate speech and harassment strictly forbidden.