Skip to content

Updated AWG and pulse gen docstrings #183

Updated AWG and pulse gen docstrings

Updated AWG and pulse gen docstrings #183

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
name: spectrumdevice-linters
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
linters:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.12"]
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v3
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install .[dev,test]
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors or undefined names
flake8 src --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 src --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Cache mypy cache
uses: AustinScola/mypy-cache-github-action@v1
- name: Check typing with mypy
run: |
mypy src/spectrumdevice
mypy src/tests
mypy src/example_scripts
- name: Fix formatting with Black
run: |
black --line-length 120 --diff --color --check src/spectrumdevice
black --line-length 120 --diff --color --check src/tests
black --line-length 120 --diff --color --check src/example_scripts