[Feature Request]: Improve documentation quality #1602
DavideDelbianco
started this conversation in
Feature requests
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
What needs to be done?
In the documentation there are parameter values that report "etc..." you cannot say etc in a documentation, how am I supposed to know what values are accepted?

example: "Controls how caching is handled (ENABLED, BYPASS, DISABLED, etc.). If None, typically defaults to ENABLED."
There's missing explanations, for example:

"If True, acts like CacheMode.BYPASS." what does that mean? I have yet to understand what bypass does. disabled and enabled are self explanatory, bypass is not IMHO.
Default values that report a "circa" value, for example "(~50)" what does it mean? is the default value 50 , 49, 51 ? "circa 50" means nothing in a type/default documentation column

What problem does this solve?
new users that read the docs would understand how the tool works.
Target users/beneficiaries
No response
Current alternatives/workarounds
No response
Proposed approach
No response
Beta Was this translation helpful? Give feedback.
All reactions