diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d5fccfb..3ad6bca 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -58,7 +58,7 @@ jobs: echo "${{ github.event.pull_request.head.sha }}" > commit_sha.txt # Workaround for codecov tokenless upload errors on external PRs - # Copied and ajusted from the workarounds suggested in the link below: + # Copied and adjusted from the workarounds suggested in the link below: # https://github.com/codecov/feedback/issues/301#issuecomment-2009355183 # Triggered sub-workflow is not able to detect the original commit/PR which is available # in this workflow. diff --git a/.github/workflows/codecov.yml b/.github/workflows/codecov.yml index 9b6ac4f..4bd8b20 100644 --- a/.github/workflows/codecov.yml +++ b/.github/workflows/codecov.yml @@ -1,7 +1,7 @@ name: CodeCov Report Upload on: - # This workflow is triggered after every successfull execution + # This workflow is triggered after every successful execution # of `ci` workflow. workflow_run: workflows: ["CI"] diff --git a/README.md b/README.md index aef46fb..93772de 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,6 @@ An [mdformat] plugin to read configuration from `pyproject.toml`. -> ⚠️ WARNING: it has been detected that some native `mdformat` options like `end_of_line` or -> `exclude` are currently being ignored when included in the `pyproject.toml` file. The issue is -> being worked on right now. You can read more here in -> [issue #4](https://github.com/csala/mdformat-pyproject/issues/4) - ## Install Install with: diff --git a/mdformat_pyproject/__init__.py b/mdformat_pyproject/__init__.py index 704c709..e64bf5e 100644 --- a/mdformat_pyproject/__init__.py +++ b/mdformat_pyproject/__init__.py @@ -1,4 +1,4 @@ -"""An mdformat plugin for...""" +"""An mdformat plugin for reading configuration from ``pyproject.toml`` files.""" __version__ = "0.0.2"