Fix docstring annotations for better rendering online#131
Merged
1 commit merged intoAug 8, 2022
Merged
Conversation
|
Build succeeded (check pipeline). |
Codecov Report
@@ Coverage Diff @@
## master #131 +/- ##
=======================================
Coverage 91.82% 91.82%
=======================================
Files 70 70
Lines 4209 4209
=======================================
Hits 3865 3865
Misses 344 344
📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
jaceksan
approved these changes
Aug 8, 2022
Sonar scan resultMore detail, see in https://sonarqube-gate.intgdc.com/dashboard?id=gooddata-python-sdk-gate-PR131 To scan for vulnerabilities in dependencies and run unit tests (to get coverage report in sonar) please comment your PR with 'extended check sonar'. |
|
Build succeeded (gate pipeline).
|
This pull request was closed.
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
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.
It seems that docstring annotations are quite fragile and have to follow very strict indentation rules to be parsed correctly by Sphinx autodoc. We should investigate if it's possible to automate this with some linters.