Skip to content

Add module-level docstring to public HTTPX API#3750

Open
enarciso2009 wants to merge 1 commit intoencode:masterfrom
enarciso2009:improve-docstrings-autocomplete
Open

Add module-level docstring to public HTTPX API#3750
enarciso2009 wants to merge 1 commit intoencode:masterfrom
enarciso2009:improve-docstrings-autocomplete

Conversation

@enarciso2009
Copy link

This PR adds a module-level docstring to httpx/__init__.py.

The goal is to improve IDE autocompletion and inline documentation when exploring
the public HTTPX API. No functional behavior is changed.

Checklist

  • I understand that this PR may be closed in case there was no previous discussion. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant