Skip to content
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

fix mkdocstrings #108

Merged
merged 1 commit into from
Mar 14, 2024
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
2 changes: 1 addition & 1 deletion {{cookiecutter.project_name}}/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ install: ## Install the poetry environment and install the pre-commit hooks
.PHONY: check
check: ## Run code quality tools.
@echo "🚀 Checking Poetry lock file consistency with 'pyproject.toml': Running poetry lock --check"
@poetry check --lock
@poetry lock --check
@echo "🚀 Linting code: Running pre-commit"
@poetry run pre-commit run -a
@echo "🚀 Static type checking: Running mypy"
Expand Down
2 changes: 1 addition & 1 deletion {{cookiecutter.project_name}}/docs/modules.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
::: {{cookiecutter.project_slug}}
::: {{cookiecutter.project_slug}}.foo
2 changes: 1 addition & 1 deletion {{cookiecutter.project_name}}/tests/test_foo.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@


def test_foo():
assert foo() == "foo"
assert foo("foo") == "foo"
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
def foo() -> str:
def foo(bar: str) -> str:
"""Summary line.

Extended description of function.

Args:
foo (str): Description of arg1
bar: Description of input argument.

Returns:
str: Description of return value
Description of return value
"""

return "foo"
return bar


if __name__ == "__main__": # pragma: no cover
Expand Down
Loading