TEST-#2966: add script for testing docs #2968
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #2968 +/- ##
===========================================
- Coverage 82.10% 65.20% -16.90%
===========================================
Files 132 132
Lines 14586 14635 +49
===========================================
- Hits 11976 9543 -2433
- Misses 2610 5092 +2482
Continue to review full report at Codecov.
|
|
|
|
Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
anmyachev
force-pushed
the
docs-ci-tool
branch
2 times, most recently
from
d28fc74 to
594c3d5
Compare
|
There's a challenge with testing documentation of the objects to which decorators are applied. |
Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
vnlitvinov
requested changes
Apr 12, 2021
Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
anmyachev
commented
Apr 12, 2021
anmyachev
commented
Apr 12, 2021
anmyachev
commented
Apr 12, 2021
anmyachev
commented
Apr 12, 2021
Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
vnlitvinov
reviewed
Apr 12, 2021
Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
Co-authored-by: Vasily Litvinov <vasilij.n.litvinov@intel.com> Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
prutskov
previously approved these changes
Apr 19, 2021
6 tasks
Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
anmyachev
dismissed stale reviews from prutskov, vnlitvinov, and YarShev
via
aa60661
…init__.py Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
… 'XGBoost' Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
YarShev
previously approved these changes
Apr 19, 2021
prutskov
previously approved these changes
Apr 19, 2021
vnlitvinov
previously approved these changes
Apr 19, 2021
anmyachev
dismissed stale reviews from vnlitvinov, prutskov, and YarShev
via
c8b0df1
Co-authored-by: Vasily Litvinov <vasilij.n.litvinov@intel.com> Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
6 tasks
prutskov
reviewed
Apr 19, 2021
scripts/doc_checker.py
Outdated
| if is_public_func(node) | ||
| ] | ||
|
|
||
| logging.info(f"NUMPYDOC OUTPUT FOR {current_path} - CAN BE EMPTY") |
There was a problem hiding this comment.
As for me, output like
INFO:NUMPYDOC OUTPUT FOR example.py CAN BE EMPTY
confuses me a little. I would prefer something like this:
INFO:NUMPYDOC CHECK FOR example.py SUCCESSFUL
There was a problem hiding this comment.
Now the message appears only in case of an error.
Example:
INFO:PYDOCSTYLE OUTPUT FOR scripts\doc_checker.py
ERROR:scripts\doc_checker.py:341 in public function `numpydoc_validate`:
D103: Missing docstring in public function
INFO:NUMPYDOC OUTPUT FOR scripts\doc_checker.py
ERROR:scripts.doc_checker.numpydoc_validate:341:GL08:The object does not have a docstring
ERROR:scripts.doc_checker.pydocstyle_validate:397:PR01:Parameters {'add_ignore'} not documented
ERROR:scripts.doc_checker.pydocstyle_validate:397:PR02:Unknown parameters {'add_ignore: List[int]'}
ERROR:scripts.doc_checker.pydocstyle_validate:397:PR10:Parameter "add_ignore" requires a space before the colon separating the parameter name and type
ERROR:INVALID DOCUMENTATION FOUNDThere was a problem hiding this comment.
@devin-petersohn now the script output is like this, see above.
Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
devin-petersohn
approved these changes
Apr 19, 2021
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Anatoly Myachev anatoly.myachev@intel.com
What do these changes do?
flake8 modinblack --check modingit commit -s