search

HEPCloud / decisionengine

HEPCloud Decision Engine framework
Apache License 2.0
6 stars 25 forks source link

Fixes to docstrings #661

Closed BrunoCoimbra closed 1 year ago

BrunoCoimbra commented 1 year ago

This PR includes fixes to a number of Sphinx errors and warnings related to docstrings throughout the code.

codecov[bot] commented 1 year ago

Codecov Report

Base: 97.27% // Head: 96.97% // Decreases project coverage by -0.30% :warning:

Coverage data is based on head (ccd3bbd) compared to base (51d5293). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #661 +/- ## ========================================== - Coverage 97.27% 96.97% -0.31% ========================================== Files 50 50 Lines 3123 3110 -13 Branches 561 488 -73 ========================================== - Hits 3038 3016 -22 - Misses 54 59 +5 - Partials 31 35 +4 ``` | Flag | Coverage Δ | | |---|---|---| | python-3.10 | `?` | | | python-3.6 | `96.97% <ø> (+0.12%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPCloud#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/HEPCloud/decisionengine/pull/661?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPCloud) | Coverage Δ | | |---|---|---| | [...rc/decisionengine/framework/dataspace/datablock.py](https://codecov.io/gh/HEPCloud/decisionengine/pull/661/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPCloud#diff-c3JjL2RlY2lzaW9uZW5naW5lL2ZyYW1ld29yay9kYXRhc3BhY2UvZGF0YWJsb2NrLnB5) | `98.82% <ø> (ø)` | | | [...aspace/datasources/sqlalchemy\_ds/datasource\_api.py](https://codecov.io/gh/HEPCloud/decisionengine/pull/661/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPCloud#diff-c3JjL2RlY2lzaW9uZW5naW5lL2ZyYW1ld29yay9kYXRhc3BhY2UvZGF0YXNvdXJjZXMvc3FsYWxjaGVteV9kcy9kYXRhc291cmNlX2FwaS5weQ==) | `98.77% <ø> (-1.23%)` | :arrow_down: | | [...decisionengine/framework/logicengine/FactLookup.py](https://codecov.io/gh/HEPCloud/decisionengine/pull/661/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPCloud#diff-c3JjL2RlY2lzaW9uZW5naW5lL2ZyYW1ld29yay9sb2dpY2VuZ2luZS9GYWN0TG9va3VwLnB5) | `100.00% <ø> (ø)` | | | [...ecisionengine/framework/logicengine/LogicEngine.py](https://codecov.io/gh/HEPCloud/decisionengine/pull/661/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPCloud#diff-c3JjL2RlY2lzaW9uZW5naW5lL2ZyYW1ld29yay9sb2dpY2VuZ2luZS9Mb2dpY0VuZ2luZS5weQ==) | `100.00% <ø> (ø)` | | | [...sionengine/framework/taskmanager/LatestMessages.py](https://codecov.io/gh/HEPCloud/decisionengine/pull/661/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPCloud#diff-c3JjL2RlY2lzaW9uZW5naW5lL2ZyYW1ld29yay90YXNrbWFuYWdlci9MYXRlc3RNZXNzYWdlcy5weQ==) | `100.00% <ø> (ø)` | | | [src/decisionengine/framework/util/countdown.py](https://codecov.io/gh/HEPCloud/decisionengine/pull/661/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPCloud#diff-c3JjL2RlY2lzaW9uZW5naW5lL2ZyYW1ld29yay91dGlsL2NvdW50ZG93bi5weQ==) | `100.00% <ø> (ø)` | | | [src/decisionengine/framework/util/reaper.py](https://codecov.io/gh/HEPCloud/decisionengine/pull/661/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPCloud#diff-c3JjL2RlY2lzaW9uZW5naW5lL2ZyYW1ld29yay91dGlsL3JlYXBlci5weQ==) | `100.00% <ø> (ø)` | | | [...ework/dataspace/datasources/sqlalchemy\_ds/utils.py](https://codecov.io/gh/HEPCloud/decisionengine/pull/661/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPCloud#diff-c3JjL2RlY2lzaW9uZW5naW5lL2ZyYW1ld29yay9kYXRhc3BhY2UvZGF0YXNvdXJjZXMvc3FsYWxjaGVteV9kcy91dGlscy5weQ==) | `84.37% <0.00%> (-15.63%)` | :arrow_down: | | [src/decisionengine/framework/dataspace/maintain.py](https://codecov.io/gh/HEPCloud/decisionengine/pull/661/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPCloud#diff-c3JjL2RlY2lzaW9uZW5naW5lL2ZyYW1ld29yay9kYXRhc3BhY2UvbWFpbnRhaW4ucHk=) | `98.03% <0.00%> (-1.97%)` | :arrow_down: | | ... and [4 more](https://codecov.io/gh/HEPCloud/decisionengine/pull/661/diff?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPCloud) | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPCloud). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPCloud)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

pep8speaks commented 1 year ago

Hello @BrunoCoimbra! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! :beers:

Comment last updated at 2022-08-31 18:47:53 UTC