projects / cli-helper.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: d0facd8)
Update FloatOption description and git clone URL
authorSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Thu, 25 Apr 2024 14:27:24 +0000 (17:27 +0300)
committerSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Thu, 25 Apr 2024 14:27:24 +0000 (17:27 +0300)
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 patch | blob | history
doc/index.org patch | blob | history
src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/FloatOption.java patch | blob | history

diff --git a/doc/index.html b/doc/index.html
index 164a576..7009a8e 100644 (file)
--- a/doc/index.html
+++ b/doc/index.html
@@ -3,7 +3,7 @@
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
 <head>
-<!-- 2023-10-29 Sun 23:27 -->
+<!-- 2024-04-25 Thu 17:26 -->
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
 <meta name="viewport" content="width=device-width, initial-scale=1" />
 <title>CLI Helper - library to help implementing commandline interfaces</title>
@@ -202,24 +202,25 @@
 <h2>Table of Contents</h2>
 <div id="text-table-of-contents" role="doc-toc">
 <ul>
-<li><a href="#org427daf2">1. General</a>
+<li><a href="#org3787d1e">1. General</a>
 <ul>
-<li><a href="#orgaf34b18">1.1. Source code</a></li>
+<li><a href="#orgc2b1e2d">1.1. Source code</a></li>
 </ul>
 </li>
-<li><a href="#org2d2e85d">2. Overview</a>
+<li><a href="#org0f28545">2. Overview</a>
 <ul>
-<li><a href="#org81434cb">2.1. Ask for user input</a></li>
+<li><a href="#orgfe545a0">2.1. Ask for user input</a></li>
 </ul>
 </li>
-<li><a href="#orgcd70162">3. Getting the library</a></li>
-<li><a href="#org7b73615">4. TODO:</a></li>
+<li><a href="#org623f251">3. Alternatives and further reading</a></li>
+<li><a href="#orgca99381">4. Getting the library</a></li>
+<li><a href="#org12a4073">5. TODO:</a></li>
 </ul>
 </div>
 </div>
 
-<div id="outline-container-org427daf2" class="outline-2">
-<h2 id="org427daf2"><span class="section-number-2">1.</span> General</h2>
+<div id="outline-container-org3787d1e" class="outline-2">
+<h2 id="org3787d1e"><span class="section-number-2">1.</span> General</h2>
 <div class="outline-text-2" id="text-1">
 <ul class="org-ul">
 <li>This program is free software: released under Creative Commons Zero
@@ -236,8 +237,8 @@
 </ul>
 </div>
 
-<div id="outline-container-orgaf34b18" class="outline-3">
-<h3 id="orgaf34b18"><span class="section-number-3">1.1.</span> Source code</h3>
+<div id="outline-container-orgc2b1e2d" class="outline-3">
+<h3 id="orgc2b1e2d"><span class="section-number-3">1.1.</span> Source code</h3>
 <div class="outline-text-3" id="text-1-1">
 <ul class="org-ul">
 <li><a href="https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a></li>
@@ -248,7 +249,7 @@
 Clone Git repository using command:
 </p>
 <pre class="example">
-git clone https://www2.svjatoslav.eu/git/cli-helper.git
+git clone https://www3.svjatoslav.eu/git/cli-helper.git
 </pre></li>
 
 <li>See <a href="https://www3.svjatoslav.eu/projects/cli-helper/apidocs/">JavaDoc</a></li>
@@ -257,8 +258,8 @@ git clone https://www2.svjatoslav.eu/git/cli-helper.git
 </div>
 </div>
 
-<div id="outline-container-org2d2e85d" class="outline-2">
-<h2 id="org2d2e85d"><span class="section-number-2">2.</span> Overview</h2>
+<div id="outline-container-org0f28545" class="outline-2">
+<h2 id="org0f28545"><span class="section-number-2">2.</span> Overview</h2>
 <div class="outline-text-2" id="text-2">
 <ul class="org-ul">
 <li>See also: <a href="https://www3.svjatoslav.eu/projects/cli-helper/apidocs/">CLI Helper JavaDoc</a></li>
@@ -275,13 +276,13 @@ dependency to your project.
 Library provides following general functionalities:
 </p>
 <ul class="org-ul">
-<li><a href="#org81434cb">Asking for user input</a></li>
+<li><a href="#orgfe545a0">Asking for user input</a></li>
 <li><a href="CLI arguments processing.html#ID-46115263-ed3d-4acc-9ec5-523d7acf87b8">Commandline arguments processing</a></li>
 </ul>
 </div>
 
-<div id="outline-container-org81434cb" class="outline-3">
-<h3 id="org81434cb"><span class="section-number-3">2.1.</span> Ask for user input</h3>
+<div id="outline-container-orgfe545a0" class="outline-3">
+<h3 id="orgfe545a0"><span class="section-number-3">2.1.</span> Ask for user input</h3>
 <div class="outline-text-3" id="text-2-1">
 <dl class="org-dl">
 <dt>askBoolean()</dt><dd>Asks the user to enter a boolean value (yes/no).</dd>
@@ -292,9 +293,18 @@ Library provides following general functionalities:
 </div>
 </div>
 
-<div id="outline-container-orgcd70162" class="outline-2">
-<h2 id="orgcd70162"><span class="section-number-2">3.</span> Getting the library</h2>
+<div id="outline-container-org623f251" class="outline-2">
+<h2 id="org623f251"><span class="section-number-2">3.</span> Alternatives and further reading</h2>
 <div class="outline-text-2" id="text-3">
+<ul class="org-ul">
+<li><a href="https://clig.dev/">Command Line Interface Guidelines</a></li>
+</ul>
+</div>
+</div>
+
+<div id="outline-container-orgca99381" class="outline-2">
+<h2 id="orgca99381"><span class="section-number-2">4.</span> Getting the library</h2>
+<div class="outline-text-2" id="text-4">
 <p>
 Instructions to embed svjatoslav-commons library in your project:
 </p>
@@ -328,9 +338,9 @@ Maven pom.xml file snippet:
 </div>
 </div>
 </div>
-<div id="outline-container-org7b73615" class="outline-2">
-<h2 id="org7b73615"><span class="section-number-2">4.</span> TODO:</h2>
-<div class="outline-text-2" id="text-4">
+<div id="outline-container-org12a4073" class="outline-2">
+<h2 id="org12a4073"><span class="section-number-2">5.</span> TODO:</h2>
+<div class="outline-text-2" id="text-5">
 <p>
 List of improvement suggestions:
 </p>
@@ -360,7 +370,7 @@ dependencies and conflicts resolution.</li>
 </div>
 <div id="postamble" class="status">
 <p class="author">Author: Svjatoslav Agejenko</p>
-<p class="date">Created: 2023-10-29 Sun 23:27</p>
+<p class="date">Created: 2024-04-25 Thu 17:26</p>
 <p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
 </div>
 </body>
diff --git a/doc/index.org b/doc/index.org
index 7519328..5f3f218 100644 (file)
--- 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 (file)
--- 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<Float, FloatOption> {
 
         @Override
         public java.lang.String describeFormat() {
-            return "Float.";
+            return "Floating point number. Example: 3.14";
         }
 
         @Override
Unnamed repository; edit this file 'description' to name the repository.