Skip to content

Add blacken-docs to pre-commit. #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ repos:


- repo: https://github.com/psf/black
rev: 22.10.0
rev: 22.12.0
hooks:
- id: black
args:
- --line-length=120

- repo: https://github.com/pycqa/isort
rev: 5.10.1
rev: 5.11.4
hooks:
- id: isort

- repo: https://github.com/PyCQA/flake8
rev: 5.0.4
rev: 6.0.0
hooks:
- id: flake8
args:
Expand All @@ -32,7 +32,7 @@ repos:
args: ["--ignore-words=ignore_words.txt"]

- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.3.0
rev: v4.4.0
hooks:
- id: check-merge-conflict
- id: debug-statements
Expand All @@ -50,3 +50,9 @@ repos:
# files: ^pyoptics/
# args: ["--ignore=D205,D100,D213"]
# additional_dependencies: [toml]

- repo: https://github.com/asottile/blacken-docs
rev: v1.12.1
hooks:
- id: blacken-docs
additional_dependencies: [black==22.12.0]
9 changes: 5 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,14 @@ Clone and install

Functionalities
^^^^^^^^^^^^^^^
All sources are located in `<src/>`_ folder.
All sources are located in `<src/>`_ folder.

.. code:: python

from src.ansys.pyoptics import speos
stub = speos.get_stub_insecure_channel()
stub...
from src.ansys.pyoptics import speos

stub = speos.get_stub_insecure_channel()
print(stub)

Documentation
-------------
Expand Down