Improve documentation for 0.4 release #2
Merged
Conversation
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
wachterjohannes
force-pushed
the
enhancement/doc
branch
3 times, most recently
from
69190d4 to
1295ff9
Compare
danrot
requested changes
Dec 5, 2016
|
|
||
| TaskScheduler | ||
| ------------- | ||
| The ``TaskScheduler`` stores tasks and schedules Executions. Foreach tasks there |
There was a problem hiding this comment.
foreach is not one english word, must be for each
There was a problem hiding this comment.
And it should be task instead of tasks
| TaskScheduler | ||
| ------------- | ||
| The ``TaskScheduler`` stores tasks and schedules Executions. Foreach tasks there | ||
| exists always on execution in the status ``planned``, ``running``. If the task |
There was a problem hiding this comment.
exactly one execution, or should that say something else?
| The ``TaskScheduler`` stores tasks and schedules Executions. Foreach tasks there | ||
| exists always on execution in the status ``planned``, ``running``. If the task | ||
| will only one time it only get one execution at all. For recurring tasks the | ||
| execution will always generated for the next run time. |
There was a problem hiding this comment.
For recurring tasks a new execution will be generated when the old one is completed.?
| - ``workload``: the workload will be passed to the handler | ||
| - ``intervall``: | ||
| - ``firstExecution``: | ||
| - ``lastExecution``: |
There was a problem hiding this comment.
I would write another short explanation or remove the colons.
wachterjohannes
force-pushed
the
enhancement/doc
branch
from
1295ff9 to
a7015b7
Compare
|
@danrot fixed |
danrot
approved these changes
Dec 6, 2016
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.
This PR improves documentation for 0.4 release