Skip to content

Commit 7bd876e

Browse files
authored
Update examples in cli.rst and fix empty section (#3363)
1 parent be4f169 commit 7bd876e

2 files changed

Lines changed: 25 additions & 6 deletions

File tree

docs/pages/usage/cli.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,20 @@ Syntax: ``wps explain <code>``
1616

1717
Examples:
1818

19-
.. code:: bash
19+
.. code:: text
2020
2121
$ wps explain WPS115
22-
WPS115 (UpperCaseAttributeViolation)
22+
WPS115 — Require ``snake_case`` for naming class attributes.
2323
24-
WPS115 - Require ``snake_case`` for naming class attributes.
24+
Attributes in Enum and enum-like classes (Django Choices)
25+
are ignored, as they should be written in UPPER_SNAKE_CASE
2526
...
2627
27-
.. code:: bash
28+
.. code:: text
2829
2930
$ wps explain 116
30-
WPS116 (ConsecutiveUnderscoresInNameViolation)
31+
WPS116 — Forbid using more than one consecutive underscore in variable names.
3132
32-
WPS116 - Forbid using more than one consecutive underscore in variable names.
33+
Reasoning:
34+
This is done to gain extra readability.
35+
...

docs/pages/usage/integrations/index.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
Integrations
2+
------------
3+
4+
WPS can integrate with lots of popular and mainstream technologies. In this section you can learn how to use them with WPS.
5+
6+
.. rubric:: Featured topics
7+
8+
- :doc:`Using WPS with Ruff <auto-formatters>`
9+
- Integrate WPS into editors and IDEs:
10+
11+
- `vscode plugin <https://code.visualstudio.com/docs/python/linting>`_
12+
- `vim plugin <https://github.com/nvie/vim-flake8>`_
13+
- `pycharm plugin <https://plugins.jetbrains.com/plugin/11563-flake8-support>`_
14+
15+
- :doc:`Run WPS linting in GitHub Actions pipelines <github-actions>`
16+
117
.. toctree::
218
:hidden:
319

0 commit comments

Comments
 (0)