chore(jobs): write proper documentation for job:history#61657
Open
Altahrim wants to merge 1 commit into
Open
Conversation
Signed-off-by: Benjamin Gaussorgues <benjamin.gaussorgues@nextcloud.com>
Altahrim
requested review from
icewind1991,
leftybournes,
nfebe and
sorbaugh
and removed request for
a team
Collaborator
Author
|
/backport to stable34 please |
CarlSchwan
approved these changes
Jun 29, 2026
joshtrichards
approved these changes
Jun 29, 2026
| Display all currently running background jobs. | ||
| List jobs previously executed by Nextcloud | ||
|
|
||
| You can find the following informations: |
Member
There was a problem hiding this comment.
Suggested change
| You can find the following informations: | |
| You can find the following information: |
Or even shorter:
Suggested change
| You can find the following informations: | |
| The output includes: |
|
|
||
| $help = <<<EOF | ||
| Display all currently running background jobs. | ||
| List jobs previously executed by Nextcloud |
Member
There was a problem hiding this comment.
nit:
Suggested change
| List jobs previously executed by Nextcloud | |
| List previously executed Nextcloud jobs |
(reads a bit more natural)
Or even:
Suggested change
| List jobs previously executed by Nextcloud | |
| List historical job executions |
(shorter + wording matches command)
| $this | ||
| ->setName('background-job:history') | ||
| ->setDescription('Show currently running jobs') | ||
| ->setDescription('List previous job executions') |
Member
There was a problem hiding this comment.
nit / just ideas:
Suggested change
| ->setDescription('List previous job executions') | |
| ->setDescription('List historical job executions') |
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
3 participants
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.
Summary
Remove copy-paste…
Checklist
3. to review, feature component)stable32)AI (if applicable)