deploy: c5a8ebd

configurations/index.html

@@ -500,13 +500,17 @@ <h2 id="generic">Generic<a class="headerlink" href="#generic" title="Permanent l
 <h3 id="executable">Executable<a class="headerlink" href="#executable" title="Permanent link">#</a></h3>
 <p>For the plugin to work, you need to define at least one executable file
 using either the <b>Global</b> or <b>Project</b> panel.</p>
-<p>Such a file is typically named <code>pyright.exe</code> and can be found in:</p>
+<p>Such a file is typically named <code>pyright</code>/<code>pyright-python</code>
+(preferably the former, if you ave both) and can be found in:</p>
 <ul>
 <li>Global: Your Python interpreter directory</li>
 <li>Virtual environment: <code>/venv/Scripts/</code> (Windows) or <code>/venv/bin</code> (Linux)</li>
 </ul>
 <p>You can also use a relative path.
 It would be interpreted as relative to the project directory.</p>
+<p>The executable is used as-is with no additional checks,
+so the plugin will still work even if, for example,
+it's a wrapper script that outputs the same diagnostics.</p>
 <h3 id="configuration-file">Configuration file<a class="headerlink" href="#configuration-file" title="Permanent link">#</a></h3>
 <p>Despite being called "file", this can be a path to a directory
 containing <code>pyright-config.json</code> and/or <code>pyproject.toml</code>.

search/search_index.json

@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Pyright for PyCharm user documentation","text":"<p>This plugin provides Pyright integration for PyCharm.</p>"},{"location":"#screenshots","title":"Screenshots","text":""},{"location":"configurations/","title":"Configurations","text":""},{"location":"configurations/#generic","title":"Generic","text":""},{"location":"configurations/#executable","title":"Executable","text":"<p>For the plugin to work, you need to define at least one executable file using either the Global or Project panel.</p> <p>Such a file is typically named <code>pyright.exe</code> and can be found in:</p> <ul> <li>Global: Your Python interpreter directory</li> <li>Virtual environment: <code>/venv/Scripts/</code> (Windows) or <code>/venv/bin</code> (Linux)</li> </ul> <p>You can also use a relative path. It would be interpreted as relative to the project directory.</p>"},{"location":"configurations/#configuration-file","title":"Configuration file","text":"<p>Despite being called \"file\", this can be a path to a directory containing <code>pyright-config.json</code> and/or <code>pyproject.toml</code>. This path will be passed to the executable via the <code>-p</code> option.</p> <ul> <li>If the executable is local, only the local path is used.</li> <li>If the executable is global, the local path is used if it is specified,   falling back to the global one.</li> </ul> <p>If the path retrieved using the aforementioned strategy is not specified, the project directory is used.</p>"},{"location":"configurations/#global","title":"Global","text":""},{"location":"configurations/#always-use-global","title":"Always use global","text":"<p>Check this option to always use the global executable and configuration file.</p> <p>Default: <code>false</code></p>"},{"location":"configurations/#use-editor-font","title":"Use editor font","text":"<p>Check this option to display annotations in your editor font. This option is not applied retroactively; you might need make an edit to see the effect.</p> <p>Default: <code>false</code></p>"}]}
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Pyright for PyCharm user documentation","text":"<p>This plugin provides Pyright integration for PyCharm.</p>"},{"location":"#screenshots","title":"Screenshots","text":""},{"location":"configurations/","title":"Configurations","text":""},{"location":"configurations/#generic","title":"Generic","text":""},{"location":"configurations/#executable","title":"Executable","text":"<p>For the plugin to work, you need to define at least one executable file using either the Global or Project panel.</p> <p>Such a file is typically named <code>pyright</code>/<code>pyright-python</code> (preferably the former, if you ave both) and can be found in:</p> <ul> <li>Global: Your Python interpreter directory</li> <li>Virtual environment: <code>/venv/Scripts/</code> (Windows) or <code>/venv/bin</code> (Linux)</li> </ul> <p>You can also use a relative path. It would be interpreted as relative to the project directory.</p> <p>The executable is used as-is with no additional checks, so the plugin will still work even if, for example, it's a wrapper script that outputs the same diagnostics.</p>"},{"location":"configurations/#configuration-file","title":"Configuration file","text":"<p>Despite being called \"file\", this can be a path to a directory containing <code>pyright-config.json</code> and/or <code>pyproject.toml</code>. This path will be passed to the executable via the <code>-p</code> option.</p> <ul> <li>If the executable is local, only the local path is used.</li> <li>If the executable is global, the local path is used if it is specified,   falling back to the global one.</li> </ul> <p>If the path retrieved using the aforementioned strategy is not specified, the project directory is used.</p>"},{"location":"configurations/#global","title":"Global","text":""},{"location":"configurations/#always-use-global","title":"Always use global","text":"<p>Check this option to always use the global executable and configuration file.</p> <p>Default: <code>false</code></p>"},{"location":"configurations/#use-editor-font","title":"Use editor font","text":"<p>Check this option to display annotations in your editor font. This option is not applied retroactively; you might need make an edit to see the effect.</p> <p>Default: <code>false</code></p>"}]}