Clean up comments

Author: ap0llo

doc/nbgv-cli.md

@@ -84,13 +84,13 @@ version and the `versionIncrement` setting in `version.json`.
 To customize this behaviour, you can either explicitly set the next version
 or override the version increment setting.
 
-To explicitly set the next version, run
+To explicitly set the next version, run:
 
 ```ps1
 nbgv prepare-release --nextVersion 2.0
 ```
 
-To override the `versionIncrement` setting from `version.json`, run
+To override the `versionIncrement` setting from `version.json`, run:
 
 ```ps1
 nbgv prepare-release --versionIncrement Major

src/NerdBank.GitVersioning/ReleaseManager.cs

@@ -6,7 +6,6 @@
     using LibGit2Sharp;
     using Validation;
     using Version = System.Version;
-    using static Nerdbank.GitVersioning.VersionOptions;
 
     /// <summary>
     /// Methods for creating releases
@@ -116,9 +115,9 @@ public ReleaseManager(TextWriter outputWriter = null, TextWriter errorWriter = n
         /// If specified, value will be used instead of the increment specified in <c>version.json</c>.
         /// Parameter will be ignored if the current branch is a release branch.
         /// </param>
-        public void PrepareRelease(string projectDirectory, string releaseUnstableTag = null, Version nextVersion = null, ReleaseVersionIncrement? versionIncrement = null)
+        public void PrepareRelease(string projectDirectory, string releaseUnstableTag = null, Version nextVersion = null, VersionOptions.ReleaseVersionIncrement? versionIncrement = null)
         {
-            Requires.NotNull(projectDirectory, nameof(projectDirectory));            
+            Requires.NotNull(projectDirectory, nameof(projectDirectory));
 
             // open the git repository
             var repository = this.GetRepository(projectDirectory);
@@ -280,7 +279,7 @@ private static bool IsVersionDecrement(SemanticVersion oldVersion, SemanticVersi
             }
         }
 
-        private SemanticVersion GetNextDevVersion(VersionOptions versionOptions, Version nextVersionOverride, ReleaseVersionIncrement? versionIncrementOverride)
+        private SemanticVersion GetNextDevVersion(VersionOptions versionOptions, Version nextVersionOverride, VersionOptions.ReleaseVersionIncrement? versionIncrementOverride)
         {
             var currentVersion = versionOptions.Version;
 
@@ -291,26 +290,26 @@ private SemanticVersion GetNextDevVersion(VersionOptions versionOptions, Version
             }
             else
             {
-                // determine the increment to use. 
-                // Use parameter if it has a value, otherwise use setting from version.json
+                // Determine the increment to use:
+                // Use parameter versionIncrementOverride if it has a value, otherwise use setting from version.json.
                 var versionIncrement = versionIncrementOverride ?? versionOptions.ReleaseOrDefault.VersionIncrementOrDefault;
 
-                // the increment is only valid if the current version has the required precision
-                // increment settings "Major" and "Minor" are always valid
-                // increment setting "Build" is only valid if the version has at lease three segments
-                var isValidIncrement = versionIncrement != ReleaseVersionIncrement.Build ||
+                // The increment is only valid if the current version has the required precision:
+                //  - increment settings "Major" and "Minor" are always valid.
+                //  - increment setting "Build" is only valid if the version has at lease three segments.
+                var isValidIncrement = versionIncrement != VersionOptions.ReleaseVersionIncrement.Build ||
                                        versionOptions.Version.Version.Build >= 0;
 
-                // increment is ignored when the next version was specified explicitly
                 if (!isValidIncrement)
                 {
-                    this.stderr.WriteLine($"Cannot apply version increment 'build' to version '{versionOptions.Version}' because it only has major and minor segments");
+                    this.stderr.WriteLine($"Cannot apply version increment 'build' to version '{versionOptions.Version}' because it only has major and minor segments.");
                     throw new ReleasePreparationException(ReleasePreparationError.InvalidVersionIncrementSetting);
                 }
 
                 nextDevVersion = currentVersion.Increment(versionIncrement);
             }
 
+            // return next version with prerelease tag specified in version.json
             return nextDevVersion.SetFirstPrereleaseTag(versionOptions.ReleaseOrDefault.FirstUnstableTagOrDefault);
         }
     }

src/nbgv/Program.cs

@@ -113,7 +113,7 @@ public static int Main(string[] args)
                 prepareRelease = syntax.DefineCommand("prepare-release", ref commandText, "Prepares a release by creating a release branch for the current version and adjusting the version on the current branch.");
                 syntax.DefineOption("p|project", ref projectPath, "The path to the project or project directory. The default is the current directory.");
                 syntax.DefineOption("nextVersion", ref releaseNextVersion, "The version to set for the current branch. If omitted, the next version is determined automatically by incrementing the current version.");
-                syntax.DefineOption("versionIncrement", ref releaseVersionIncrement, "Specifies how the next version for the current branch is determined overriding the 'versionIncrement' setting in version.json");
+                syntax.DefineOption("versionIncrement", ref releaseVersionIncrement, "Overrides the 'versionIncrement' setting set in version.json for determining the next version of the current branch.");
                 syntax.DefineParameter("tag", ref releasePreReleaseTag, "The prerelease tag to apply on the release branch (if any). If not specified, any existing prerelease tag will be removed. The preceding hyphen may be omitted.");
 
                 if (syntax.ActiveCommand == null)
@@ -579,7 +579,7 @@ private static ExitCodes OnPrepareReleaseCommand(string projectPath, string prer
                 return ExitCodes.InvalidParameters;
             }
 
-            // parse versionIncrement is parameter was specified
+            // parse versionIncrement if parameter was specified
             VersionOptions.ReleaseVersionIncrement? versionIncrementParsed = default;
             if (!string.IsNullOrEmpty(versionIncrement))
             {