Skip to content

Commit

Permalink
Minor image modifications
Browse files Browse the repository at this point in the history
  • Loading branch information
InSyncWithFoo committed Apr 10, 2024
1 parent 4d1f29b commit 5e997e7
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 21 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG_CODE.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For user-facing changes, see [`CHANGELOG.md`][_-1].
* The "Always use global" and "Auto-suggest executable" are moved back
to the first column of the first row. (6e6c6df6)
* [@gradle/wrapper-validation-action][10-3] is updated to 2.1.3. (1c38c5ac)
* [The docs][10-4] are rewritten to reflect both plugins. (HEAD)
* [The docs][10-4] are rewritten to reflect both plugins. (4d1f29b6, HEAD)

### Fixed

Expand Down
28 changes: 8 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ It works by saving all your files as-is before running
the executable provided by you. If you are not OK with that,
please <em>do not</em> install this plugin.

Note: If you use PyCharm Professional, install
[the <i>Pyright Language Server</i> plugin][2] instead.
Note: If you use PyCharm Professional,
install [the <i>Pyright Language Server</i> plugin][2] instead.


## Usage
Expand Down Expand Up @@ -48,30 +48,18 @@ Currently supported versions:
2024.1 (build 241.14494.241) - 2024.1.* (build 241.*).


## Known issues

This is only a minimum viable product.

* There are very few tests. Manual checks are only performed on Windows.
* Since `ExternalAnnotator`s are only called after all other annotators
have run, expect a major delay (up to a few seconds) between checks.

If you are interested in contributing to this project,
see [the contributing guide][9].


## Credits

Most of the code is derived from [@koxudaxi/ruff-pycharm-plugin][10].
Most of the code is derived from [@koxudaxi/ruff-pycharm-plugin][9].
It is such a fortune that that plugin does almost the same thing
and is also written in Kotlin, and hence easily understandable.

The SVG and PNG logos are derived from [the README image][11]
The SVG and PNG logos are derived from [the README image][10]
of the [@microsoft/pyright][1] repository,
generated using Inkscape's autotrace feature.

Some other files are based on or copied directly from
[@JetBrains/intellij-platform-plugin-template][12].
[@JetBrains/intellij-platform-plugin-template][11].


[4]: https://plugins.jetbrains.com/
Expand All @@ -80,6 +68,6 @@ Some other files are based on or copied directly from
[7]: https://github.com/InSyncWithFoo/pyright-for-pycharm/actions/workflows/build.yaml
[8]: https://www.jetbrains.com/help/pycharm/managing-plugins.html#install_plugin_from_disk
[9]: ./CONTRIBUTING.md
[10]: https://github.com/koxudaxi/ruff-pycharm-plugin
[11]: https://github.com/microsoft/pyright/blob/main/docs/img/PyrightLarge.png
[12]: https://github.com/JetBrains/intellij-platform-plugin-template
[9]: https://github.com/koxudaxi/ruff-pycharm-plugin
[10]: https://github.com/microsoft/pyright/blob/main/docs/img/PyrightLarge.png
[11]: https://github.com/JetBrains/intellij-platform-plugin-template
Binary file added docs/assets/cli-global-configuration-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/cli-project-configuration-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/lsp-global-configuration-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/lsp-project-configuration-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<b>Pyright (Global)</b> / <b>Pyright (Project)</b>
and set the path to [your Pyright executable][1].

![](./assets/cli-global-configuration-panel.png)
![](./assets/cli-project-configuration-panel.png)

Save, return to your file and start making some modifications.
Expand All @@ -16,6 +17,7 @@
<b>Pyright LS (Global)</b> / <b>Pyright LS (Project)</b>
and set the path to [your Pyright language server executable][1].

![](./assets/lsp-global-configuration-panel.png)
![](./assets/lsp-project-configuration-panel.png)

You might need to reopen your files or restart the IDE
Expand Down

0 comments on commit 5e997e7

Please sign in to comment.