Best Practices document
Open
Nobody has claimed this yet.
topic: documentation
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 302
- Avg merge
- 23h
- Merged PRs (30d)
- 8
Description
- Built-in generics
- New union syntax
- No union return types, use
AnyorT | Any - Discuss
Anyvsobject - Callbacks: Use return type
objectinstead ofNoneorAnyif the returned value is ignored
Please add anything you think the document should contain.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the proposed topics in this issue and review the repository's existing typing documentation before deciding where a best-practices document belongs. Confirm the guidance for built-in generics, union syntax, return types, Any versus object, and callbacks, then define the document's scope and completion criteria with project maintainers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100