Changeset 68 in code

Timestamp:

Aug 21, 2024, 2:15:27 AM (8 months ago)

Author:

yakumo.izuru

Message:

Update inline documentation

Signed-off-by: Izuru Yakumo <yakumo.izuru@…>

Location:

trunk

Files:

• Makefile (modified) (2 diffs)
• cli/edit.ml (modified) (1 diff)
• cli/new.ml (modified) (1 diff)
• cli/txt.ml (modified) (2 diffs)
• logarion.opam (modified) (1 diff)

trunk/Makefile

@@ -11 +11 @@
         @dune build
 deps:
-        @opam install dune ocurl cmdliner=1.0.4 msgpck
+        @opam install dune ocurl cmdliner msgpck
 cli:
         @dune build cli/txt.exe
@@ -20 +20 @@
         @cp _build/default/cli/txt.exe txt.exe
         @strip txt.exe
-        @tar czvf "kosuzu-${OS}-${MACHINE}-${DATE}-${COMMIT}" txt.exe readme.txt
+        @tar czvf "logarion-${OS}-${MACHINE}-${DATE}-${COMMIT}" txt.exe readme.txt
         @rm txt.exe
 install:

trunk/cli/edit.ml

@@ -15 +15 @@
       `S Manpage.s_description;
       `P "Launches EDITOR (nano if environment variable is unset) with text path as parameter.";
-      `P "If -R is used, the ID search space includes texts found in subdirectories, too." ]
+      `P "If -R is used, the ID search space includes texts found in subdirectories, too.";
+      `S Manpage.s_environment;
+      `P "EDITOR - Default editor name" ]
   in
   let info = Cmd.info "edit" ~version:"%%VERSION%%" ~doc ~man in

trunk/cli/new.ml

@@ -24 +24 @@
   let man = [
       `S Manpage.s_description;
-      `P "Create a new article, with title 'Draft' when none provided" ]
+      `P "Create a new article, with title 'Draft' when none provided";
+      `S Manpage.s_environment;
+      `P "USER - The login name of the user, used if the Authors field is blank";
+      `P "EDITOR - Default editor name" ]
   in
   let info = Cmd.info "new" ~version:"%%VERSION%%" ~doc ~man in

trunk/cli/txt.ml

@@ -2 +2 @@
 
 let subs = [
-    Authors.cmd; (* Done *)
-    Convert.cmd; (* Done *)
-    Edit.cmd; (* Done *)
-    File.cmd; (* Done *)
-    Index.cmd; (* Done *)
-    Last.cmd; (* Done *)
-    Listing.cmd; (* Done *)
-    New.cmd; (* Done *)
-    Peers.cmd; (* Done *)
-    Pull.cmd; (* Done *)
-    Recent.cmd; (* Done *)
-    Topics.cmd; (* Done *)
-    Unfile.cmd; (* Done *)
+    Authors.cmd;
+    Convert.cmd;
+    Edit.cmd;
+    File.cmd;
+    Index.cmd;
+    Last.cmd;
+    Listing.cmd;
+    New.cmd;
+    Peers.cmd;
+    Pull.cmd;
+    Recent.cmd;
+    Topics.cmd;
+    Unfile.cmd;
   ]
 
@@ -22 +22 @@
   let doc = "Discover, collect and exchange texts" in
   let man = [
-      `S "CONTACT";
-      `P "<mailto:logarion-dev@chaotic.ninja>"; ]
+      `S Manpage.s_authors;
+      `P "orbifx <mailto:fox@orbitalfox.eu>";
+      `P "Izuru Yakumo <mailto:yakumo.izuru@chaotic.ninja>";
+      `S Manpage.s_bugs;
+      `P "Please report them at <mailto:logarion-dev@chaotic.ninja>"; ]
   in
   Cmd.group (Cmd.info "txt" ~version:"%%VERSION%%" ~doc ~man) ~default:default_cmd subs

trunk/logarion.opam

@@ -1 +1 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "1.4.0"
+version: "1.4.1"
 synopsis: "Texts archival and exchange"
 maintainer: ["Izuru Yakumo <yakumo.izuru@chaotic.ninja>"]