Updated Docstring engine #1229
Merged
Updated Docstring engine #1229
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
Codecov ReportAttention:
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## develop #1229 +/- ##
===========================================
- Coverage 88.16% 84.11% -4.06%
===========================================
Files 79 148 +69
Lines 5257 11863 +6606
===========================================
+ Hits 4635 9978 +5343
- Misses 622 1885 +1263 ☔ View full report in Codecov by Sentry. |
dweindl
approved these changes
Dec 1, 2023
| @@ -8,7 +8,7 @@ class Task(abc.ABC): | |||
| Abstract Task class. | |||
|
|
|||
| A task is one of a list of independent execution tasks that are | |||
| submitted to the execution engine to be executed using the execute() | |||
| submitted to the execution engine to be executed using the :func:`execute` | |||
There was a problem hiding this comment.
Suggested change
| submitted to the execution engine to be executed using the :func:`execute` | |
| submitted to the execution engine to be executed using the :meth:`execute` |
Maybe func works as well.
Co-authored-by: Daniel Weindl <dweindl@users.noreply.github.com>
Doresic
approved these changes
Dec 1, 2023
| self, tasks: List[Task], progress_bar: bool = True | ||
| ) -> List[Any]: | ||
| self, tasks: list[Task], progress_bar: bool = True | ||
| ) -> list[Any]: |
There was a problem hiding this comment.
Is there any difference in using list or List?
There was a problem hiding this comment.
Same effect, but List and the like are deprecated as of python3.9 (https://docs.python.org/3/library/typing.html#deprecated-aliases)
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.
Updated the doctoring of the engine module.