Skip to content

Commit 4ebf262

Browse files
committed
Fix documentation coverage search directory
1 parent f015e1c commit 4ebf262

File tree

3 files changed

+20
-9
lines changed

3 files changed

+20
-9
lines changed

.github/workflows/CheckDocumentation.yml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,20 @@ jobs:
6464
- name: Run 'interrogate' Documentation Coverage Check
6565
continue-on-error: true
6666
run: |
67-
interrogate -c pyproject.toml --fail-under=${{ inputs.fail_under }} && printf "::error title=%s::%s\n" "interrogate" "Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
67+
set +e
68+
69+
interrogate -c pyproject.toml --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }}
70+
if [[ $? -ne 0 ]]; then
71+
printf "::error title=%s::%s\n" "interrogate" "Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
72+
fi
6873
6974
- name: Run 'docstr_coverage' Documentation Coverage Check
7075
continue-on-error: true
7176
run: |
72-
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 }})"
77+
set +e
78+
79+
docstr-coverage --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }}
80+
if [[ $? -ne 0 ]]; then
81+
printf "%s\n" "::error title=docstr-coverage::Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
82+
fi
83+

.github/workflows/CompletePipeline.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ jobs:
193193
- UnitTestingParams
194194
with:
195195
python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
196-
directory: ${{ inputs.package_namespace }}/${{ inputs.package_name }}
196+
directory: ${{ needs.ConfigParams.outputs.package_directory }}
197197
# fail_below: 70
198198

199199
Package:

pyDummy/__init__.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ class Base:
5353
_value: int #: An internal value.
5454

5555
def __init__(self) -> None:
56-
"""
57-
Initializes the base-class.
58-
"""
56+
# """
57+
# Initializes the base-class.
58+
# """
5959
self._value = 0
6060

6161
@readonly
@@ -75,9 +75,9 @@ class Application(Base):
7575
"""
7676

7777
def __init__(self) -> None:
78-
"""
79-
Initializes the dummy application.
80-
"""
78+
# """
79+
# Initializes the dummy application.
80+
# """
8181
super().__init__()
8282

8383
platform = Platform()

0 commit comments

Comments
 (0)