Skip to content

Fix docstring annotations for better rendering online#131

Merged
1 commit merged into
gooddata:masterfrom
andriichumak:features/fix-autodoc-formatting
Aug 8, 2022
Merged

Fix docstring annotations for better rendering online#131
1 commit merged into
gooddata:masterfrom
andriichumak:features/fix-autodoc-formatting

Conversation

@andriichumak

Copy link
Copy Markdown

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.

@andriichumak andriichumak requested a review from lupko August 5, 2022 16:25
@ghost

ghost commented Aug 5, 2022

Copy link
Copy Markdown

Build succeeded (check pipeline).

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

Merging #131 (80a5682) into master (f7ad8b2) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #131   +/-   ##
=======================================
  Coverage   91.82%   91.82%           
=======================================
  Files          70       70           
  Lines        4209     4209           
=======================================
  Hits         3865     3865           
  Misses        344      344           
Impacted Files Coverage Δ
gooddata-fdw/gooddata_fdw/column_utils.py 94.11% <ø> (ø)
gooddata-pandas/gooddata_pandas/dataframe.py 100.00% <ø> (ø)
gooddata-pandas/gooddata_pandas/series.py 95.00% <ø> (ø)
.../gooddata_sdk/catalog/workspace/model_container.py 85.71% <ø> (ø)
...data-sdk/gooddata_sdk/catalog/workspace/service.py 95.95% <ø> (ø)
...oddata-sdk/gooddata_sdk/compute/model/execution.py 87.73% <ø> (ø)
gooddata-sdk/gooddata_sdk/compute/service.py 100.00% <ø> (ø)
gooddata-sdk/gooddata_sdk/insight.py 77.31% <ø> (ø)
gooddata-sdk/gooddata_sdk/support.py 93.93% <ø> (ø)
gooddata-sdk/gooddata_sdk/table.py 84.95% <ø> (ø)
... and 2 more

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@andriichumak andriichumak requested a review from jaceksan August 8, 2022 09:13
@jaceksan jaceksan added the merge label Aug 8, 2022
@yenkins

yenkins commented Aug 8, 2022

Copy link
Copy Markdown

Sonar scan result

More 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'.

@ghost ghost removed the merge label Aug 8, 2022
@ghost ghost merged commit 42e166f into gooddata:master Aug 8, 2022
@ghost

ghost commented Aug 8, 2022

Copy link
Copy Markdown

This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants