Improve docstrings, add API section to Sphinx #112
Merged
Conversation
This file contains 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
cmarqu
commented
Aug 27, 2023
junitparser/junitparser.py
Outdated
| @@ -647,15 +643,15 @@ def write(self, filepath: str = None, pretty=False): | |||
| class JUnitXml(Element): | |||
| """The JUnitXml root object. | |||
|
|
|||
| It may contains a :class:`TestSuites` or a :class:`TestSuite`. | |||
| It may contain :class:`TestSuites` or a :class:`TestSuite`. | |||
There was a problem hiding this comment.
Actually, there is no TestSuites class (anymore?).
There was a problem hiding this comment.
I think this note refers to <TestSuites> and <TestSuite> tags that can be the root element of the XML.
There was a problem hiding this comment.
I changed this accordingly.
cmarqu
force-pushed
the
doc-improvements
branch
2 times, most recently
from
0456014 to
7d5deb5
Compare
EnricoMi
reviewed
Aug 28, 2023
EnricoMi
approved these changes
Aug 28, 2023
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## master #112 +/- ##
=======================================
Coverage 98.24% 98.24%
=======================================
Files 8 8
Lines 1428 1428
=======================================
Hits 1403 1403
Misses 25 25
☔ View full report in Codecov by Sentry. |
cmarqu
force-pushed
the
doc-improvements
branch
from
16d5cbc to
a875691
Compare
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.
No description provided.