[gardening] improve markdown formatting in documentation comments

swiftlang · May 9, 2021 · 13d808f · 13d808f
1 parent 4585260
commit 13d808f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 13 deletions.
diff --git a/Sources/PackageDescription/Version+StringLiteralConvertible.swift b/Sources/PackageDescription/Version+StringLiteralConvertible.swift
@@ -9,11 +9,8 @@
 */
 
 extension Version: ExpressibleByStringLiteral {
-
     /// Initializes a version struct with the provided string literal.
-    ///
-    /// - Parameters:
-    ///     - version: A string literal to use for creating a new version struct.
+    /// - Parameter version: A string literal to use for creating a new version struct.
     public init(stringLiteral value: String) {
         if let version = Version(value) {
             self = version
@@ -45,11 +42,8 @@ extension Version: ExpressibleByStringLiteral {
 }
 
 extension Version {
-
     /// Initializes a version struct with the provided version.
-    ///
-    /// - Parameters:
-    ///     - version: A version object to use for creating a new version struct.
+    /// - Parameter version: A version object to use for creating a new version struct.
     public init(_ version: Version) {
         major = version.major
         minor = version.minor

diff --git a/Sources/PackageDescription/Version.swift b/Sources/PackageDescription/Version.swift
@@ -55,11 +55,11 @@ public struct Version {
     /// Initializes a version struct with the provided components of a semantic version.
     ///
     /// - Parameters:
-    ///     - major: The major version number.
-    ///     - minor: The minor version number.
-    ///     - patch: The patch version number.
-    ///     - prereleaseIdentifiers: The pre-release identifier.
-    ///     - buildMetaDataIdentifiers: Build metadata that identifies a build.
+    ///   - major: The major version number.
+    ///   - minor: The minor version number.
+    ///   - patch: The patch version number.
+    ///   - prereleaseIdentifiers: The pre-release identifier.
+    ///   - buildMetaDataIdentifiers: Build metadata that identifies a build.
     public init(
         _ major: Int,
         _ minor: Int,