Fix C coverage support for sphinx.ext.coverage
#11591
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
We were using the 'objects' attribute of the C domain to pull all C objects that we were aware of. However, this is never set to any value nor does it ever appear to have been. Instead, we should have been using and parsing the return value from 'get_objects'. As an aside, this would suggest code coverage for C APIs has never worked or at least has not worked for a *very* long time. This explains why every GitHub hit for the various configuration options comes from Sphinx (for the implementation), Python (for the sole user), or a fork of these. Signed-off-by: Stephen Finucane <stephen@that.guru>
Prevent regressions but including a positive test alongside the negative test. We could probably make this more thorough and improve the C source so that it shows examples of other types of C object, but that's a task left for another day/PR. Signed-off-by: Stephen Finucane <stephen@that.guru>
|
@stephenfin please could you add a note to CHANGES? I'd like to include this in 7.2. A |
Signed-off-by: Stephen Finucane <stephen@that.guru>
Done 👍 |
|
Thanks! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Feature or Bugfix
Purpose
We were using the
objectsattribute of the C domain to pull all C objects that we were aware of. However, this is never set to any value nor does it ever appear to have been. Instead, we should have been using and parsing the return value fromget_objects.As an aside, this would suggest code coverage for C APIs has never worked or at least has not worked for a very long time. This explains why every GitHub hit for the various configuration options comes from Sphinx (for the implementation), Python (for the sole user), or a fork of these. This might be a good time to deprecate and remove this aspect of the coverage extension. We can discuss that elsewhere.
Detail
sphinx.ext.coverageis non-functional #11590Relates
(none)