Give an example of using follow_imports_for_stubs in the docs

Open Beginner friendly
#4,860 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Start by finding the documentation that explains the follow_imports_for_stubs option and read its current wording. Add a concrete usage example and a motivating use case, then verify that the explanation clearly describes when the setting is useful.

Written by the indexing model from the issue text.

Description

documentation priority-0-high

I think that the current explanation for follow_imports_for_stubs might be a bit confusing and a concrete example would help. It would also be nice if there was a motivating use case for this (say, your code monkey patches some library module and mypy doesn't recognize this; or your code is using some internal features of a module that aren't included in a typeshed stub).

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.