Document properties of internal type operations

Open
#3,454 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
devtools

Research direction

The issue names no specific file, test, or entry point. Start by locating the internal type-operation implementations in the mypy source, then inventory the operations and their existing comments or docstrings; done means documenting their compatibility, subtyping, joins, meets, and other relevant properties.

Written by the indexing model from the issue text.

Description

documentation priority-1-normal refactoring

Document basic properties of all type operations used within mypy, including compatibility, proper subtyping, joins and meets. The properties include things like associativity, symmetry, how they work with Any -- and there are many other properties potentially worth documenting. The documentation would be in the form of comments or docstrings within the source code.

Dominant language
Python
Stars
20.6k
Forks
3.3k
Avg merge
1d 18h
Merged PRs (30d)
54

Contributor guide

Open the contributing guide

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 python/mypy

All issues in python/mypy

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.