basedpyright icon indicating copy to clipboard operation
basedpyright copied to clipboard

Documentation on `typeCheckingMode`

Open aytey opened this issue 2 months ago • 2 comments

Description

Is it documented anywhere what the "meaning" behind the different options for typeCheckingMode mean?

For example, how "strict" compares to "recommended" or "all" compares to "strict"? It is also slightly unclear if "all" is "stricter" than "strict" or not (I believe it is, but I cannot find it documented anywhere).

aytey avatar Nov 05 '25 09:11 aytey

there's some documentation about it here and here but i agree it's probably a bit difficult to follow considering it's tacked onto the docs that were already there in pyright

would be happy to accept any suggestions or a PR to improve the docs. otherwise we can close this issue if you feel that the sections i linked are sufficient

DetachHead avatar Nov 05 '25 13:11 DetachHead

Oh, the second link is great -- close to perfectly what I need! I did actually find #type-check-diagnostics-settings but I didn't make my way down to #diagnostic-settings-defaults.

Maybe a solution here is just to add a link to #diagnostic-settings-defaults from #type-check-diagnostics-settings?

A new bullet point with something like: "to understand what is enabled in the different levels, please see #diagnostic-settings-defaults" would be wonderful.

aytey avatar Nov 05 '25 14:11 aytey