Skip to content

Commit

Permalink
enable more strict validation in mkdocs and fix some broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
DetachHead committed Sep 30, 2024
1 parent 824efea commit 7a67d13
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/benefits-over-pyright/pypi-package-vscode-pinning.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ python developers should not be expected to have to install nodejs in order to t

in pyright, if the vscode extension gets updated, you may see errors in your project that don't appear in the CI, or vice-versa. see [this issue](https://github.com/microsoft/pylance-release/issues/5207).

basedpyright fixes this problem by adding an `importStrategy` option to the extension, which defaults to looking in your project for the [basedpyright pypi package](#published-as-a-pypi-package---no-nodejs-required).
basedpyright fixes this problem by adding an `importStrategy` option to the extension, which defaults to looking in your project for the [basedpyright pypi package](#pypi-package-no-nodejs-required).
2 changes: 1 addition & 1 deletion docs/configuration/config-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ there are rules in pyright that are discouraged in basedpyright because we provi

- <a name="enableTypeIgnoreComments"></a> **enableTypeIgnoreComments** [boolean]: PEP 484 defines support for `# type: ignore` comments. This switch enables or disables support for these comments. This option is discouraged in favor of `# pyright: ignore` comments in basedpyright, as they are safer. [See here](../benefits-over-pyright/new-diagnostic-rules.md#reportignorecommentwithoutrule) for more information.

- <a name="enableReachabilityAnalysis"></a> **enableReachabilityAnalysis** [boolean]: If enabled, code that is determined to be unreachable by type analysis is reported using a tagged hint. This setting does not affect code that is determined to be unreachable regardless of type analysis; such code is always reported as unreachable. This setting also has no effect when when using the command-line version of pyright because it never emits tagged hints for unreachable code. this rule is discouraged in basedpyright in favor of [`reportUnreachable`](#/?id=reportunreachable-report-errors-on-code-that-would-otherwise-be-completely-unchecked).
- <a name="enableReachabilityAnalysis"></a> **enableReachabilityAnalysis** [boolean]: If enabled, code that is determined to be unreachable by type analysis is reported using a tagged hint. This setting does not affect code that is determined to be unreachable regardless of type analysis; such code is always reported as unreachable. This setting also has no effect when when using the command-line version of pyright because it never emits tagged hints for unreachable code. this rule is discouraged in basedpyright in favor of [`reportUnreachable`](../benefits-over-pyright/new-diagnostic-rules.md#reportunreachable).

## Execution Environment Options
Pyright allows multiple “execution environments” to be defined for different portions of your source tree. For example, a subtree may be designed to run with different import search paths or a different version of the python interpreter than the rest of the source base.
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/command-line-and-language-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ once installed, the `basedpyright` and `basedpyright-langserver` scripts will be
basedpyright --help
```

for instructions on how to use `basedpyright-langserver`, see the [IDE-specific instructions below](#ides).
for instructions on how to use `basedpyright-langserver`, see the [IDE-specific instructions below](./ides.md).
2 changes: 1 addition & 1 deletion docs/installation/ides.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ LSP for the editor. These configurations are for launching the LSP server,
as well as for being able to give launching parameters at the same time.

To install the **necessary sever command**, for the LSP server itself, use the
[pypi package installation method](#command-line--language-server) (as
[pypi package installation method](./command-line-and-language-server.md) (as
mentioned previously in this section). Or if already using
[Mason.nvim](https://github.com/williamboman/mason.nvim), follow their
instructions for installing their packages. The latter approach allows you to
Expand Down
8 changes: 8 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,11 @@ repo_url: https://github.com/detachhead/basedpyright
repo_name: detachhead/basedpyright
extra_css:
- stylesheets/extra.css
validation:
nav:
omitted_files: warn
absolute_links: info # using awesome-pages plugin so it doesn't recognize them
links:
anchors: warn
absolute_links: warn
unrecognized_links: warn

0 comments on commit 7a67d13

Please sign in to comment.