diff --git a/.github/workflows/verify-docs.yml b/.github/workflows/verify-docs.yml index 082636d1..0b25675d 100644 --- a/.github/workflows/verify-docs.yml +++ b/.github/workflows/verify-docs.yml @@ -1,8 +1,5 @@ name: verify mkdocs build -on: - pull_request: - branches: - - master +on: [pull_request] jobs: verify-docs: name: Verify docs @@ -19,11 +16,5 @@ jobs: pip install -r requirements.txt pip install -r requirements-dev.txt pip install -e . - - name: Install mkdocs dependencies - run: | - pip install --upgrade pip - pip install mkdocs - pip install mkdocstrings - pip install mkdocs-material - name: Build site run: mkdocs build --strict diff --git a/cellengine/resources/scaleset.py b/cellengine/resources/scaleset.py index 7c48d8ca..72789974 100644 --- a/cellengine/resources/scaleset.py +++ b/cellengine/resources/scaleset.py @@ -72,11 +72,11 @@ def apply( """Apply the scaleset to a file. Args: - file (_id or FcsFile): The file to which this scaleset will be + file: The file to which this scaleset will be applied. - clamp_q (bool): Clamp the output to the scale's minimum and maximum + clamp_q: Clamp the output to the scale's minimum and maximum values. - in_place (bool): If True, updates the FcsFile.events; if + in_place: If True, updates the FcsFile.events; if False, returns a DataFrame """ if isinstance(file, str): diff --git a/requirements-dev.txt b/requirements-dev.txt index 173ebf53..0e6a779f 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -5,7 +5,7 @@ responses~=0.10 flake8~=3.7 black~=22.3 Pillow~=9.0 -mkdocs~=1.1 +mkdocs~=1.3 mkdocs-material~=7.3 mkdocs-material-extensions~=1.0 -mkdocstrings[python]~=0.18 +mkdocstrings[python]~=0.19