From a6d309e51d47dfa2d5077581b1a4210191bd07aa Mon Sep 17 00:00:00 2001 From: Ryan Morshead Date: Wed, 20 Nov 2024 00:58:21 -0700 Subject: [PATCH] remove mdformat because of (#13) - https://github.com/executablebooks/mdformat/issues/319 - and more generally https://github.com/executablebooks/mdformat/issues/53 --- docs/src/concepts.md | 3 +++ project.py | 7 ------- pyproject.toml | 5 ----- 3 files changed, 3 insertions(+), 12 deletions(-) diff --git a/docs/src/concepts.md b/docs/src/concepts.md index 8abb9bb..878f5d7 100644 --- a/docs/src/concepts.md +++ b/docs/src/concepts.md @@ -96,6 +96,7 @@ def get_message(*, recipient: Recipient = required) -> str: ``` !!! warning + Don't forget to add the `required` default value. Without it, PyBooster will not know that the argument is a dependency that needs to be injected. @@ -424,6 +425,7 @@ with solution(sqlite_connection.bind(":memory:")): ``` !!! note + Bindable parameters are not allowed to be dependencies. ### Generic Providers @@ -533,6 +535,7 @@ with solution(config_file_provider.bind(Config, json_file)): ``` !!! tip + This approach also works great for a provider that has `overload` implementations. ### Singleton Providers diff --git a/project.py b/project.py index 3dba3c1..30cee68 100644 --- a/project.py +++ b/project.py @@ -49,14 +49,12 @@ def cov(no_test: bool, no_report: bool): @main.command("lint") @click.option("--check", is_flag=True, help="Check for linting issues without fixing.") -@click.option("--no-md-style", is_flag=True, help="Style check Markdown files.") @click.option("--no-py-style", is_flag=True, help="Style check Python files.") @click.option("--no-py-types", is_flag=True, help="Type check Python files.") @click.option("--no-uv-locked", is_flag=True, help="Check that the UV lock file is synced") @click.option("--no-yml-style", is_flag=True, help="Style check YAML files.") def lint( check: bool, - no_md_style: bool, no_py_style: bool, no_py_types: bool, no_uv_locked: bool, @@ -72,11 +70,6 @@ def lint( else: run(["ruff", "format"]) run(["ruff", "check", "--fix"]) - if not no_md_style: - if check: - run(["mdformat", "--ignore-missing-references", "--check", "."]) - else: - run(["mdformat", "--ignore-missing-references", "."]) if not no_yml_style: if check: run(["yamlfix", "--check", "."]) diff --git a/pyproject.toml b/pyproject.toml index a7a00cf..510d6ce 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -45,11 +45,6 @@ docs = [ ] lint = [ { include-group = "test" }, - "mdformat-mkdocs==3.1.1", - "mdformat-pyproject==0.0.1", - "mdformat-ruff==0.1.3", - "mdformat-tables==1.0.0", - "mdformat==0.7.19", "pyright==1.1.389", "ruff==0.7.3", "yamlfix==1.17.0",