From cac1de8529482bb373e8275095f5e8bc32c7430d Mon Sep 17 00:00:00 2001 From: Nashwan Azhari Date: Mon, 8 Jul 2024 12:48:26 +0300 Subject: [PATCH] Minor docstring fixes. Signed-off-by: Nashwan Azhari --- gleam.toml | 2 +- src/gleamsver.gleam | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/gleam.toml b/gleam.toml index 6665f49..f17eb66 100644 --- a/gleam.toml +++ b/gleam.toml @@ -1,5 +1,5 @@ name = "gleamsver" -version = "1.0.0" +version = "1.0.1" description = "Comprehensive set of native Gleam utilities for handling SemVer 2.0.0 version strings." licences = ["MIT"] diff --git a/src/gleamsver.gleam b/src/gleamsver.gleam index 3b20313..97fce0b 100644 --- a/src/gleamsver.gleam +++ b/src/gleamsver.gleam @@ -89,7 +89,7 @@ pub const empty_semver = SemVer(0, 0, 0, "", "") /// // -> Ok(SemVer(major: 1, minor; 2, patch: 3, pre: "rc0", build: "20240505")) /// ``` /// -/// Both the Pre-release ("-rc0") and Build ("+20240505") parts are optional: +/// Both the Pre-release (`-rc0`) and Build (`+20240505`) parts are optional: /// /// ```gleam /// parse("4.5.6-rc0") @@ -117,7 +117,7 @@ pub const empty_semver = SemVer(0, 0, 0, "", "") /// /// ```gleam /// parse("abc") -/// -> MissingMajor("Leading Major SemVer Integer part is missing.") +/// // -> MissingMajor("Leading Major SemVer Integer part is missing.") /// // To get the error String directly, simply: /// parse("abc") |> result.map_error(string_from_parsing_error) /// // -> Error("Leading Major SemVer Integer part is missing.") @@ -390,7 +390,7 @@ pub fn are_compatible(v1: SemVer, with v2: SemVer) -> Bool { /// /// ## Examples /// -/// ```gleams +/// ```gleam /// are_equal_core(SemVer(1, 2, 3, "", ""), with: SemVer(1, 2, 3, "", "")) /// // -> True ///