Skip to content

Commit 8bf1239

Browse files
authored
Use yaml file instead of deprecated .docstr_coverage file (pyccel#1816)
According to the docstring of `docstr-coverage`, the flag `--docstr-ignore-file` is deprecated. A json config file should be used instead. This PR updates our methodology to use that flag
1 parent 9212f42 commit 8bf1239

File tree

3 files changed

+12
-6
lines changed

3 files changed

+12
-6
lines changed

.docstr.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
skip_magic: True
2+
skip_init: True
3+
fail_under: 0
4+
ignore_patterns:
5+
"syntactic":
6+
- "_visit_.*"
7+
"semantic":
8+
- "_visit_.*"
9+
".*code":
10+
- "_print_.*"

.docstr_coverage

Lines changed: 0 additions & 3 deletions
This file was deleted.

.github/workflows/docs.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,8 @@ jobs:
7474
- name: Check doc coverage
7575
id: doc_coverage
7676
run: |
77-
echo "${{ github.event.pull_request.base.sha }}"
78-
docstr-coverage --skip-magic --skip-init --fail-under=0 --docstr-ignore-file=base/.docstr_coverage base/pyccel base/ci_tools 2>&1 | tee base_cov
79-
docstr-coverage --skip-magic --skip-init --fail-under=0 --docstr-ignore-file=compare/.docstr_coverage compare/pyccel compare/ci_tools 2>&1 | tee compare_cov
77+
docstr-coverage --config=base/.docstr.yaml base/pyccel base/ci_tools 2>&1 | tee base_cov
78+
docstr-coverage --config=compare/.docstr.yaml compare/pyccel compare/ci_tools 2>&1 | tee compare_cov
8079
export PYTHONPATH=compare
8180
python compare/ci_tools/summarise_doccoverage.py compare_cov base_cov $GITHUB_STEP_SUMMARY
8281
shell: bash

0 commit comments

Comments
 (0)