Skip to content

Commit 74ac834

Browse files
authored
Separate help text from description (#9)
1 parent 2eaf322 commit 74ac834

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,7 @@ $ echo $?
4848

4949
$ composer-semver normalize --help
5050
Description:
51-
Normalizes a version string to be able to perform comparisons on it.
52-
This is a wrapper of the Composer\Semver\VersionParser::normalize() method.
51+
Normalizes a version string to be able to perform comparisons on it
5352

5453
Usage:
5554
normalize [options] [--] <version>
@@ -66,6 +65,9 @@ Options:
6665
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
6766
-n, --no-interaction Do not ask any interactive question
6867
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
68+
69+
Help:
70+
This is a wrapper of the Composer\Semver\VersionParser::normalize() method.
6971
```
7072

7173
### Parse Constraints
@@ -92,8 +94,7 @@ $ echo $?
9294

9395
$ composer-semver parse --help
9496
Description:
95-
Parses a constraint string and strip its ignorable parts.
96-
This is a wrapper of the Composer\Semver\VersionParser::parseConstraints() method.
97+
Parses a constraint string and strip its ignorable parts
9798

9899
Usage:
99100
parse <constraints>
@@ -109,6 +110,9 @@ Options:
109110
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
110111
-n, --no-interaction Do not ask any interactive question
111112
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
113+
114+
Help:
115+
This is a wrapper of the Composer\Semver\VersionParser::parseConstraints() method.
112116
```
113117

114118
### Print Bundled PHP and `composer/semver` Versions

src/NormalizeCommand.php

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,8 @@
1313

1414
#[AsCommand(
1515
name: 'normalize',
16-
description: <<<'DESCRIPTION'
17-
Normalizes a version string to be able to perform comparisons on it.
18-
This is a wrapper of the <href=https://github.com/composer/semver/blob/b52829022cb18210bb84e44e457bd4e890f8d2a7/src/VersionParser.php#L98-L108>Composer\Semver\VersionParser::normalize()</> method.
19-
DESCRIPTION,
16+
description: 'Normalizes a version string to be able to perform comparisons on it',
17+
help: 'This is a wrapper of the <href=https://github.com/composer/semver/blob/b52829022cb18210bb84e44e457bd4e890f8d2a7/src/VersionParser.php#L98-L108>Composer\Semver\VersionParser::normalize()</> method.',
2018
)]
2119
class NormalizeCommand extends Command
2220
{

src/ParseCommand.php

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,8 @@
1212

1313
#[AsCommand(
1414
name: 'parse',
15-
description: <<<'DESCRIPTION'
16-
Parses a constraint string and strip its ignorable parts.
17-
This is a wrapper of the <href=https://github.com/composer/semver/blob/b52829022cb18210bb84e44e457bd4e890f8d2a7/src/VersionParser.php#L251-L258>Composer\Semver\VersionParser::parseConstraints()</> method.
18-
DESCRIPTION,
15+
description: 'Parses a constraint string and strip its ignorable parts',
16+
help: 'This is a wrapper of the <href=https://github.com/composer/semver/blob/b52829022cb18210bb84e44e457bd4e890f8d2a7/src/VersionParser.php#L251-L258>Composer\Semver\VersionParser::parseConstraints()</> method.',
1917
)]
2018
class ParseCommand extends Command
2119
{

0 commit comments

Comments
 (0)