You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by GitBox <gi...@apache.org> on 2022/11/13 13:00:24 UTC
[GitHub] [maven-site] elharo commented on a diff in pull request #331: [MNG-7559] Fix versions comparison
elharo commented on code in PR #331:
URL: https://github.com/apache/maven-site/pull/331#discussion_r1020898806
##########
content/apt/pom.apt.vm:
##########
@@ -515,7 +515,18 @@ mvn install:install-file -Dfile=non-maven-proj.jar -DgroupId=some.group -Dartifa
* the "<<<alpha>>>", "<<<beta>>>" and "<<<milestone>>>" qualifiers can respectively be shortened to "a", "b" and "m" when directly followed by a number.
- * else "<<<.qualifier>>>" \< "<<<-qualifier>>>" \< "<<<-number>>>" \< "<<<.number>>>"
+ * else "<<<.qualifier>>>" = "<<<-qualifier>>>" \< "<<<-number>>>" \< "<<<.number>>>"
+
+ * <<<alpha>>> = <<<a>>> < <<<beta>>> = <<<b>>> < <<<ea>>> < <<<milestone>>> = <<<m>>> < <<<preview>>> < <<<rc>>> = <<<cr>>> < <<<snapshot>>> < '<<<>>>' = <<<final>>> = <<<ga>>> = <<<release>>> \< <<<sp>>>
+
+ []
+
+ following semver rules is encouraged, and some qualifiers are discouraged:
+ * prefer '<<<alpha>>>', '<<<beta>>>' and '<<<milestone>>>' qualifiers over '<<<ea>>>' and '<<<preview>>>'
Review Comment:
Capitialize prefer and other first words below
##########
content/apt/pom.apt.vm:
##########
@@ -527,17 +538,17 @@ mvn install:install-file -Dfile=non-maven-proj.jar -DgroupId=some.group -Dartifa
* "<<<1-foo2>>>" \< "<<<1-foo10>>>" (correctly automatically "switching" to numeric order)
- * "<<<1.foo>>>" \< "<<<1-foo>>>" \< "<<<1-1>>>" \< "<<<1.1>>>"
+ * "<<<1.foo>>>" = "<<<1-foo>>>" \< "<<<1-1>>>" \< "<<<1.1>>>"
- * "<<<1.ga>>>" = "<<<1-ga>>>" = "<<<1-0>>>" = "<<<1.0>>>" = "<<<1>>>" (removing of trailing "null" values)
+ * "<<<1.ga>>>" = "<<<1-ga>>>" = "<<<1-0>>>" = "<<<1.0>>>" = "<<<1>>>" (removing of trailing "null" values)
- * "<<<1-sp>>>" \> "<<<1-ga>>>"
+ * "<<<1-sp>>>" \> "<<<1-ga>>>"
- * "<<<1-sp.1>>>" \> "<<<1-ga.1>>>"
+ * "<<<1-sp.1>>>" \> "<<<1-ga.1>>>"
- * "<<<1-sp-1>>>" \< "<<<1-ga-1>>>" = "<<<1-1>>>" (trailing "null" values at each hyphen)
+ * "<<<1-sp-1>>>" \> "<<<1-ga-1>>>" = "<<<1-1>>>" (trailing "null" values at each hyphen)
Review Comment:
This is very iffy. What does the code actually do? It's not enough to say it in the docs. The code has to agree. I assume the current docs are accurate on how the algorithm works, absent a unit test proving otherwise.
##########
content/apt/pom.apt.vm:
##########
@@ -515,7 +515,18 @@ mvn install:install-file -Dfile=non-maven-proj.jar -DgroupId=some.group -Dartifa
* the "<<<alpha>>>", "<<<beta>>>" and "<<<milestone>>>" qualifiers can respectively be shortened to "a", "b" and "m" when directly followed by a number.
- * else "<<<.qualifier>>>" \< "<<<-qualifier>>>" \< "<<<-number>>>" \< "<<<.number>>>"
+ * else "<<<.qualifier>>>" = "<<<-qualifier>>>" \< "<<<-number>>>" \< "<<<.number>>>"
+
+ * <<<alpha>>> = <<<a>>> < <<<beta>>> = <<<b>>> < <<<ea>>> < <<<milestone>>> = <<<m>>> < <<<preview>>> < <<<rc>>> = <<<cr>>> < <<<snapshot>>> < '<<<>>>' = <<<final>>> = <<<ga>>> = <<<release>>> \< <<<sp>>>
+
+ []
+
+ following semver rules is encouraged, and some qualifiers are discouraged:
Review Comment:
capitalize following
##########
content/apt/pom.apt.vm:
##########
@@ -515,7 +515,18 @@ mvn install:install-file -Dfile=non-maven-proj.jar -DgroupId=some.group -Dartifa
* the "<<<alpha>>>", "<<<beta>>>" and "<<<milestone>>>" qualifiers can respectively be shortened to "a", "b" and "m" when directly followed by a number.
- * else "<<<.qualifier>>>" \< "<<<-qualifier>>>" \< "<<<-number>>>" \< "<<<.number>>>"
+ * else "<<<.qualifier>>>" = "<<<-qualifier>>>" \< "<<<-number>>>" \< "<<<.number>>>"
+
+ * <<<alpha>>> = <<<a>>> < <<<beta>>> = <<<b>>> < <<<ea>>> < <<<milestone>>> = <<<m>>> < <<<preview>>> < <<<rc>>> = <<<cr>>> < <<<snapshot>>> < '<<<>>>' = <<<final>>> = <<<ga>>> = <<<release>>> \< <<<sp>>>
+
+ []
+
+ following semver rules is encouraged, and some qualifiers are discouraged:
+ * prefer '<<<alpha>>>', '<<<beta>>>' and '<<<milestone>>>' qualifiers over '<<<ea>>>' and '<<<preview>>>'
+ * prefer '<<<1.0.0-RC1>>>'' over '<<<1.0.0.RC1>>>'
+ * the usage of '<<<CR>>>' qualifier is discouraged, use '<<<RC>>>' instead.
Review Comment:
run-on sentence. comma should be period
##########
content/apt/pom.apt.vm:
##########
@@ -515,7 +515,18 @@ mvn install:install-file -Dfile=non-maven-proj.jar -DgroupId=some.group -Dartifa
* the "<<<alpha>>>", "<<<beta>>>" and "<<<milestone>>>" qualifiers can respectively be shortened to "a", "b" and "m" when directly followed by a number.
- * else "<<<.qualifier>>>" \< "<<<-qualifier>>>" \< "<<<-number>>>" \< "<<<.number>>>"
+ * else "<<<.qualifier>>>" = "<<<-qualifier>>>" \< "<<<-number>>>" \< "<<<.number>>>"
+
+ * <<<alpha>>> = <<<a>>> < <<<beta>>> = <<<b>>> < <<<ea>>> < <<<milestone>>> = <<<m>>> < <<<preview>>> < <<<rc>>> = <<<cr>>> < <<<snapshot>>> < '<<<>>>' = <<<final>>> = <<<ga>>> = <<<release>>> \< <<<sp>>>
+
+ []
+
+ following semver rules is encouraged, and some qualifiers are discouraged:
+ * prefer '<<<alpha>>>', '<<<beta>>>' and '<<<milestone>>>' qualifiers over '<<<ea>>>' and '<<<preview>>>'
+ * prefer '<<<1.0.0-RC1>>>'' over '<<<1.0.0.RC1>>>'
+ * the usage of '<<<CR>>>' qualifier is discouraged, use '<<<RC>>>' instead.
+ * the usage of '<<<final>>>', '<<<ga>>>', '<<<release>>>' qualifiers is discouraged, use no qualifier instead.
Review Comment:
run-on sentence. comma should be period
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org