From cd2156bfd53f0802aa34b5d225c0129d2d4f238f Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Thu, 25 Apr 2024 17:27:24 +0300 Subject: [PATCH] Update FloatOption description and git clone URL In the FloatOption.java file, the description for float values has been updated to include a more descriptive example. Additionally, the git clone URL in the documentation (index.org and index.html files) has been revised from www2 to www3 for accuracy and consistency. --- doc/index.html | 56 +++++++++++-------- doc/index.org | 2 +- .../parameter/FloatOption.java | 2 +- 3 files changed, 35 insertions(+), 25 deletions(-) diff --git a/doc/index.html b/doc/index.html index 164a576..7009a8e 100644 --- a/doc/index.html +++ b/doc/index.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + CLI Helper - library to help implementing commandline interfaces @@ -202,24 +202,25 @@

Table of Contents

-
-

1. General

+
+

1. General

  • This program is free software: released under Creative Commons Zero @@ -236,8 +237,8 @@
-
-

1.1. Source code

+
+

1.1. Source code

  • Download latest snapshot in TAR GZ format
    • @@ -248,7 +249,7 @@ Clone Git repository using command: 

    -git clone https://www2.svjatoslav.eu/git/cli-helper.git
+git clone https://www3.svjatoslav.eu/git/cli-helper.git
  • See JavaDoc
    • @@ -257,8 +258,8 @@ git clone https://www2.svjatoslav.eu/git/cli-helper.git
-
-

2. Overview

+
+

2. Overview

-
-

2.1. Ask for user input

+
+

2.1. Ask for user input

askBoolean()
Asks the user to enter a boolean value (yes/no).
@@ -292,9 +293,18 @@ Library provides following general functionalities:
-
-

3. Getting the library

+
+

3. Alternatives and further reading

+ +
+
+ +
+

4. Getting the library

+

Instructions to embed svjatoslav-commons library in your project:

@@ -328,9 +338,9 @@ Maven pom.xml file snippet:
-
-

4. TODO:

-
+
+

5. TODO:

+

List of improvement suggestions:

@@ -360,7 +370,7 @@ dependencies and conflicts resolution.

Author: Svjatoslav Agejenko

-

Created: 2023-10-29 Sun 23:27

+

Created: 2024-04-25 Thu 17:26

Validate

diff --git a/doc/index.org b/doc/index.org index 7519328..5f3f218 100644 --- a/doc/index.org +++ b/doc/index.org @@ -20,7 +20,7 @@ - [[https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=summary][Browse Git repository online]] - Clone Git repository using command: - : git clone https://www2.svjatoslav.eu/git/cli-helper.git + : git clone https://www3.svjatoslav.eu/git/cli-helper.git - See [[https://www3.svjatoslav.eu/projects/cli-helper/apidocs/][JavaDoc]] diff --git a/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/FloatOption.java b/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/FloatOption.java index f84b334..1ab5ec4 100644 --- a/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/FloatOption.java +++ b/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/FloatOption.java @@ -11,7 +11,7 @@ public class FloatOption extends Option { @Override public java.lang.String describeFormat() { - return "Float."; + return "Floating point number. Example: 3.14"; } @Override -- 2.20.1