Skip to content

bug(mkdocs): typing error #155

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 4 commits into from
Sep 10, 2022
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
11 changes: 1 addition & 10 deletions .github/workflows/verify-docs.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
name: verify mkdocs build
on:
pull_request:
branches:
- master
on: [pull_request]
jobs:
verify-docs:
name: Verify docs
Expand All @@ -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
6 changes: 3 additions & 3 deletions cellengine/resources/scaleset.py
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
4 changes: 2 additions & 2 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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