Repository navigation
Environment Variables docs should justify each usage case. #404
Description
Our environment variable documentation should include some justification or context for each case, by doing one of the following for each envvar:
- Make it clear that an environment variable is specific to HTTPX. (Probably only relevant to anything prefixed by
HTTPX_) - Make it clear that an environment variable is used as a convention by various tooling, with at least one relevant hyperlink.
Eg.
SSLKEYLOGFILE could give some more context about usage - "The keylog file is designed for debugging purposes only." doesn't make it clear how or when to use it, or which debug tooling it's usful with.
SSL_CERT_FILE and SSL_CERT_DIR can include a link to some docs about their convention. Perhaps give an example of other tooling that supports them?
HTTP_PROXY, HTTPS_PROXY, ALL_PROXY can include a link to some docs about their convention. Perhaps give an example of other tooling that supports them?
Activity
mwoss commentedon Oct 22, 2019
May I take over it?
lovelydinosaur commentedon Oct 23, 2019
We'll happily take any contributions here yup.
mwoss commentedon Oct 23, 2019
Ok, I will take care of it tommorow or on Friday.
edit:
I have much work to do at university, sorry. I'll try to create PR tomorrow.
Edited documentation about proxy-envs usage (encode#404)
Edited documentation about proxy-envs usage (encode#404)
PR review (encode#404)
PR review (encode#404)
Edited documentation about proxy-envs usage (#404) (#1257)
cwkang1998 commentedon Sep 27, 2021
Is this task done? Does it still need help working on?
lovelydinosaur commentedon Feb 16, 2022
I don't think there's anything worthwhile doing here, nope.