Update the help output for the occ files:scan command by settermjd · Pull Request #29581 · owncloud/core

settermjd · 2017-11-15T12:24:32Z

Description

Ensures that the descriptions for all commands in occ help files:scan are rendered consistently, and grammatically correct.

Related Issue

#29580.

Motivation and Context

The help output for occ files:scan renders inconsistently, both for capitalisation at the start of sentences, as well as for full-stops at the end of sentences. This decreases the readability of the command's output and detracts from a completely professional appearance.

How Has This Been Tested?

Re-ran the test suite.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests have passed.

Also Relates To

owncloud-archive/documentation#3542

settermjd · 2017-11-15T13:47:09Z

In hindsight, I think I should have created this PR as a series of commits, and not one great big one.

codecov · 2017-11-15T13:57:53Z

Codecov Report

Merging #29581 into master will decrease coverage by 0.7%.
The diff coverage is 51.38%.

@@             Coverage Diff              @@
##             master   #29581      +/-   ##
============================================
- Coverage     62.47%   61.77%   -0.71%     
+ Complexity    17544    17482      -62     
============================================
  Files          1045     1047       +2     
  Lines         57770    57723      -47     
============================================
- Hits          36092    35657     -435     
- Misses        21678    22066     +388

Impacted Files	Coverage Δ	Complexity Δ
core/Command/Security/ImportCertificate.php	`0% <0%> (ø)`	`4 <0> (ø)`	⬇️
core/Command/Security/ListRoutes.php	`0% <0%> (ø)`	`27 <0> (ø)`	⬇️
core/Command/User/Enable.php	`0% <0%> (-100%)`	`4 <0> (ø)`
core/Command/L10n/CreateJs.php	`0% <0%> (ø)`	`19 <0> (ø)`	⬇️
core/Command/Maintenance/Repair.php	`0% <0%> (ø)`	`19 <0> (ø)`	⬇️
core/Command/Encryption/Status.php	`0% <0%> (ø)`	`3 <0> (ø)`	⬇️
core/Command/Status.php	`0% <0%> (ø)`	`2 <0> (ø)`	⬇️
core/Command/User/Add.php	`0% <0%> (-55.3%)`	`16 <0> (ø)`
core/Command/User/ListUsers.php	`0% <0%> (-100%)`	`4 <0> (ø)`
core/Command/User/Disable.php	`0% <0%> (-100%)`	`4 <0> (ø)`
... and 96 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a277026...b9cf787. Read the comment docs.

phil-davis · 2017-11-15T14:21:52Z

You missed a capital "L" and full-stop here?

phil-davis · 2017-11-15T14:22:46Z

Seems "a good thing" to me.

mmattel · 2017-11-15T18:39:29Z

👍

mmattel · 2017-11-15T19:05:43Z

Maybe: „Lists the groups a user belongs to“

mmattel · 2017-11-15T19:08:00Z

Maybe: ...contains the optional search pattern

DeepDiver1975 · 2017-11-15T20:24:38Z

@ownclouders rebase

ownclouders · 2017-11-15T20:24:40Z

Hey! This pull request is being rebased automatically. Please DO NOT push while rebase is in progress or your changes would be lost!

ownclouders · 2017-11-15T20:25:01Z

Automated rebase was successful!

mmattel · 2017-11-20T08:50:37Z

@settermjd mind to complete the PR so it can be finally reviewed and merged before 10.0.4 gets released ?
The open doc PR is depending on this one too...

mmattel · 2017-11-24T10:07:22Z

@settermjd any updates on the open comments ?

mmattel · 2017-11-29T07:39:25Z

@PVince81 is it normal hat drone takes 18h and is still not finished...?
(Edit: after drone beeing open for +20h, squashed which restarted testing)

PVince81 · 2017-11-29T10:14:37Z

@mmattel I heard about some hardware issues on which Drone and Jenkins run... I hope we can sort this out soon.

mmattel · 2017-11-29T12:08:34Z

@PVince81 glory, test passed 😄. Mind to give your (hopefully positive) review so it can be merged?

PVince81

Fantastic! Consistency FTW!

👍

PVince81 · 2017-11-29T13:07:18Z

@settermjd please backport to stable10 for 10.0.5

mmattel · 2017-12-22T09:45:08Z

@settermjd I have not seen the backport (or missed it...), may I remind you and can you refrence from the backport to here respectively to #29580, thanks

phil-davis · 2017-12-22T10:10:29Z

Backport stable10 #29959
(it was an easy cherry-pick with no conflicts)

mmattel · 2017-12-22T10:14:04Z

thx @phil-davis

settermjd · 2018-01-09T10:38:00Z

Thanks for the help @mmattel @phil-davis. Confirmed as working in a local installation of 10.0.4.

lock · 2019-08-01T12:02:47Z

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

settermjd self-assigned this Nov 15, 2017

settermjd requested a review from PVince81 November 15, 2017 12:24

DeepDiver1975 added this to the development milestone Nov 15, 2017

DeepDiver1975 added 3 - To Review backport-request labels Nov 15, 2017

settermjd force-pushed the update-occ-files_scan-help-output branch from b60282d to 7ba0e73 Compare November 15, 2017 13:44

settermjd force-pushed the update-occ-files_scan-help-output branch from 7ba0e73 to b48ba99 Compare November 15, 2017 13:57

phil-davis reviewed Nov 15, 2017

View reviewed changes

Comment thread core/Command/User/SyncBackend.php Outdated

phil-davis Nov 15, 2017

Copy link
Copy Markdown

Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You missed a capital "L" and full-stop here?

mmattel reviewed Nov 15, 2017

View reviewed changes

Comment thread core/Command/User/ListUserGroups.php Outdated

mmattel Nov 15, 2017

Copy link
Copy Markdown

Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe: „Lists the groups a user belongs to“

mmattel reviewed Nov 15, 2017

View reviewed changes

Comment thread core/Command/User/ListUsers.php Outdated

mmattel Nov 15, 2017

Copy link
Copy Markdown

Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe: ...contains the optional search pattern

ownclouders force-pushed the update-occ-files_scan-help-output branch from b48ba99 to 0869089 Compare November 15, 2017 20:25

mmattel mentioned this pull request Nov 16, 2017

10.0.4 release notes draft owncloud-archive/documentation#3533

Merged

Update occ command help output

b9cf787

mmattel force-pushed the update-occ-files_scan-help-output branch from c2b2c72 to b9cf787 Compare November 29, 2017 09:30

PVince81 approved these changes Nov 29, 2017

View reviewed changes

PVince81 merged commit 5c0803e into master Nov 29, 2017

PVince81 deleted the update-occ-files_scan-help-output branch November 29, 2017 13:07

ownclouders added the status/STALE label Dec 20, 2017

ownclouders removed the status/STALE label Dec 22, 2017

phil-davis mentioned this pull request Dec 22, 2017

[stable10] Update occ command help output #29959

Merged

PVince81 removed the backport-request label Jan 8, 2018

ownclouders mentioned this pull request Oct 12, 2018

Confusing help message in occ command for default output format #33168

Closed

lock Bot locked as resolved and limited conversation to collaborators Aug 1, 2019

Uh oh!

Conversation

settermjd commented Nov 15, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

Also Relates To

Uh oh!

settermjd commented Nov 15, 2017

Uh oh!

codecov Bot commented Nov 15, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

phil-davis Nov 15, 2017

Choose a reason for hiding this comment

Uh oh!

phil-davis commented Nov 15, 2017

Uh oh!

mmattel commented Nov 15, 2017

Uh oh!

mmattel Nov 15, 2017

Choose a reason for hiding this comment

Uh oh!

mmattel Nov 15, 2017

Choose a reason for hiding this comment

Uh oh!

DeepDiver1975 commented Nov 15, 2017

Uh oh!

ownclouders commented Nov 15, 2017

Uh oh!

ownclouders commented Nov 15, 2017

Uh oh!

mmattel commented Nov 20, 2017

Uh oh!

mmattel commented Nov 24, 2017

Uh oh!

mmattel commented Nov 29, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

PVince81 commented Nov 29, 2017

Uh oh!

mmattel commented Nov 29, 2017

Uh oh!

PVince81 left a comment

Choose a reason for hiding this comment

Uh oh!

PVince81 commented Nov 29, 2017

Uh oh!

mmattel commented Dec 22, 2017

Uh oh!

phil-davis commented Dec 22, 2017

Uh oh!

mmattel commented Dec 22, 2017

Uh oh!

settermjd commented Jan 9, 2018

Uh oh!

lock Bot commented Aug 1, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

settermjd commented Nov 15, 2017 •

edited

Loading

codecov Bot commented Nov 15, 2017 •

edited

Loading

mmattel commented Nov 29, 2017 •

edited

Loading