Skip to content
Snippets Groups Projects
Commit fbc6eed8 authored by Oscar Gustafsson's avatar Oscar Gustafsson :bicyclist:
Browse files

Add doc-string linting with velin

parent fda26535
No related branches found
No related tags found
1 merge request!237Add doc-string linting with velin
Pipeline #90540 passed
...@@ -110,6 +110,9 @@ run-doc-test: ...@@ -110,6 +110,9 @@ run-doc-test:
script: script:
- pip install -r requirements_doc.txt - pip install -r requirements_doc.txt
- sphinx-build -b html docs_sphinx public - sphinx-build -b html docs_sphinx public
# Run linting on doc-strings
- pip install black velin
- velin . --check --black
pages: pages:
variables: variables:
......
...@@ -18,3 +18,7 @@ repos: ...@@ -18,3 +18,7 @@ repos:
hooks: hooks:
- id: isort - id: isort
name: isort (python) name: isort (python)
- repo: https://github.com/Carreau/velin
rev: 0.0.12
hooks:
- id: velin
...@@ -253,7 +253,7 @@ class Operation(GraphComponent, SignalSourceProvider): ...@@ -253,7 +253,7 @@ class Operation(GraphComponent, SignalSourceProvider):
that are encountered, and be updated with their new values. that are encountered, and be updated with their new values.
prefix : str, optional prefix : str, optional
Used as a prefix for the key string when storing results/delays. Used as a prefix for the key string when storing results/delays.
bits_override ; int, optional bits_override : int, optional
Specifies a word length override when truncating inputs Specifies a word length override when truncating inputs
which ignores the word length specified by the input signal. which ignores the word length specified by the input signal.
truncate : bool, default: True truncate : bool, default: True
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment