8000 Fix trailing spaces · ssbarnea/python@dbbed46 · GitHub
[go: up one dir, main page]
Skip to content

Commit dbbed46

Browse files
ssbarneassbarnea
committed
Fix trailing spaces
- Adds pre-commit config for fixing spaces automatically - Fix trailing spaces (done automatically)
1 parent 4ce0fc8 commit dbbed46

File tree

4 files changed

+24
-11
lines changed

4 files changed

+24
-11
lines changed

‎.pre-commit-config.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
ci:
3+
autoupdate_commit_msg: "chore: pre-commit autoupdate"
4+
autoupdate_schedule: monthly
5+
autofix_commit_msg: |
6+
chore: auto fixes from pre-commit.com hooks
7+
8+
for more information, see https://pre-commit.ci
9+
repos:
10+
- repo: https://github.com/pre-commit/pre-commit-hooks.git
11+
rev: v4.4.0
12+
hooks:
13+
- id: trailing-whitespace

‎CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ make setup
1919
> you'll need to install
2020
> [PDM](https://github.com/pdm-project/pdm)
2121
> manually.
22-
>
22+
>
2323
> You can install it with:
24-
>
24+
>
2525
> ```bash
2626
> python3 -m pip install --user pipx
2727
> pipx install pdm
2828
> ```
29-
>
29+
>
3030
> Now you can try running `make setup` again,
3131
> or simply `pdm install`.
3232

‎docs/usage.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Usage
22

3-
TIP: **This is the documentation for the NEW Python handler.**
3+
TIP: **This is the documentation for the NEW Python handler.**
44
To read the documentation for the LEGACY handler,
55
go to the [legacy handler documentation](https://mkdocstrings.github.io/python-legacy).
66

@@ -34,7 +34,7 @@ Some options are **global only**, and go directly under the handler's name.
3434
to other documentation sites like the standard library docs
3535
or any third-party package docs. Typically, you want to import
3636
the inventories of your project's dependencies, at least those
37-
that are used in the public API.
37+
that are used in the public API.
3838
3939
NOTE: This global option is common to *all* handlers, however
4040
they might implement it differently (or not even implement it).
@@ -115,11 +115,11 @@ For example:
115115
This admonition has a custom title!
116116
"""
117117
```
118-
118+
119119
=== "Result"
120120
NOTE: It looks like a section, but it will be rendered as an admonition.
121121

122-
TIP: **You can even choose a title.**
122+
TIP: **You can even choose a title.**
123123
This admonition has a custom title!
124124

125125
## Finding modules
@@ -208,7 +208,7 @@ to make sure anyone can build your docs from any location on their filesystem.
208208

209209
### Using the PYTHONPATH environment variable
210210

211-
WARNING: **This method has limitations.**
211+
WARNING: **This method has limitations.**
212212
This method might work for you, with your current setup,
213213
but not for others trying your build your docs with their own setup/environment.
214214
We recommend to use the [`paths` method](#using-the-paths-option) instead.
@@ -264,10 +264,10 @@ In Bash and other shells, you can run your command like this
264264
```bash
265265
PYTHONPATH=src mkdocs build -f docs/mkdocs.yml
266266
```
267-
267+
268268
### Installing your package in the current Python environment
269269

270-
WARNING: **This method has limitations.**
270+
WARNING: **This method has limitations.**
271271
This method might work for you, with your current setup,
272272
but not for others trying your build your docs with their own setup/environment.
273273
We recommend to use the [`paths` method](#using-the-paths-option) instead.

‎src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@
8080
{% endif %}
8181
{% if parameter.default %}
8282
<span class="doc-param-default">
83-
<b>DEFAULT:</b>
83+
<b>DEFAULT:</b>
8484
{% with expression = parameter.default %}
8585
<code>{% include "expression.html" with context %}</code>
8686
{% endwith %}

0 commit comments

Comments
 (0)
0