Improve docstring structuring for code autocompletion.

Open
  • Is something wrong?
#857 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Start with the package init.py and review the public API for missing or inconsistent docstrings. Determine a consistent placement and style for class and init docstrings, then verify that public symbols are documented in a way that supports code autocompletion.

Written by the indexing model from the issue text.

Description

Originally opened by @tomchristie on 2024-10-22 09:28:00 in encode/httpx

  • The __init__.py module should include a docstring.
  • Should class docstrings be on the class itself or on the class __init__ method (or both?).
  • Review if we've currently got a docstring on all public API, and review consistency & styling throughout.
Dominant language
Python
Stars
1.6k
Forks
103
Avg merge
1d 19h
Merged PRs (30d)
25

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pydantic/httpx2

All issues in pydantic/httpx2

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.