This repository was archived by the owner on Jun 16, 2021. It is now read-only.
File tree Expand file tree Collapse file tree 1 file changed +10
-4
lines changed
Expand file tree Collapse file tree 1 file changed +10
-4
lines changed Original file line number Diff line number Diff line change @@ -7,13 +7,19 @@ formatter. The formatter uses
77
88## Features
99
10- See https://pypi.org/project/docformatter/ for the full feature list. This extension
11- uses that project as a backend with few modifications. To run the formatter after
12- installing, simply open a Python file and run the ` Format Document ` command. All
13- other Python formatters installed will run as well.
10+ See https://pypi.org/project/docformatter/ for the full feature list. This
11+ extension uses that project as a backend with few modifications.
1412
1513All relevant flags are implemented as [ extension settings] ( #extension-settings ) .
1614
15+ ## How to Use
16+
17+ If you already have a Python formatting extension installed, you will need to
18+ pick this one when you want to format a file. In a Python file in VSCode,
19+ <kbd >ctrl</kbd >+<kbd >shift</kbd >+<kbd >p</kbd > to open the command pallette,
20+ run the command * Format Document With...* and select
21+ * Python Docstring Formatter* .
22+
1723## Requirements
1824
1925This extension requires ` pip ` and/or the ` docformatter ` module to be installed.
You can’t perform that action at this time.
0 commit comments