pyTooling/Actions
1
0
Fork 0
mirror of https://github.com/pyTooling/Actions.git synced 2026-02-12 11:06:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation coverage search directory

Browse Source
This commit is contained in:
Patrick Lehmann
2025-04-26 18:50:07 +02:00
parent f015e1c3a0
commit 4ebf262921
3 changed files with 20 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
.github/workflows/CheckDocumentation.yml vendored
View File

@@ -64,9 +64,20 @@ jobs:
- name: Run 'interrogate' Documentation Coverage Check
continue-on-error: true
run: |
interrogate -c pyproject.toml --fail-under=${{ inputs.fail_under }} && printf "::error title=%s::%s\n" "interrogate" "Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
set +e
interrogate -c pyproject.toml --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }}
if [[ $? -ne 0 ]]; then
printf "::error title=%s::%s\n" "interrogate" "Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
fi
- name: Run 'docstr_coverage' Documentation Coverage Check
continue-on-error: true
run: |
docstr-coverage -v 2 --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }} && printf "%s\n" "::error title=docstr-coverage::Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
set +e
docstr-coverage --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }}
if [[ $? -ne 0 ]]; then
printf "%s\n" "::error title=docstr-coverage::Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
fi

2
.github/workflows/CompletePipeline.yml vendored
View File

@@ -193,7 +193,7 @@ jobs:
- UnitTestingParams
with:
python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
directory: ${{ inputs.package_namespace }}/${{ inputs.package_name }}
directory: ${{ needs.ConfigParams.outputs.package_directory }}
# fail_below: 70
Package:

12
pyDummy/__init__.py
View File

@@ -53,9 +53,9 @@ class Base:
_value: int #: An internal value.
def __init__(self) -> None:
"""
Initializes the base-class.
"""
# """
# Initializes the base-class.
# """
self._value = 0
@readonly
@@ -75,9 +75,9 @@ class Application(Base):
"""
def __init__(self) -> None:
"""
Initializes the dummy application.
"""
# """
# Initializes the dummy application.
# """
super().__init__()
platform = Platform()