[latex3-commits] [latex3/l3sys-query] main: Leave command invocation in SYNOPSIS section only (63466e6)

github at latex-project.org github at latex-project.org
Wed Apr 3 18:45:54 CEST 2024


Repository : https://github.com/latex3/l3sys-query
On branch  : main
Link       : https://github.com/latex3/l3sys-query/commit/63466e6f580e00590b46a2d055f995d8bd21626c

>---------------------------------------------------------------

commit 63466e6f580e00590b46a2d055f995d8bd21626c
Author: Yukai Chou <muzimuzhi at gmail.com>
Date:   Thu Apr 4 00:23:30 2024 +0800

    Leave command invocation in SYNOPSIS section only
    
    This also removes the leading space before "Usage" in SYNOPSIS.


>---------------------------------------------------------------

63466e6f580e00590b46a2d055f995d8bd21626c
 CHANGELOG.md | 3 +++
 build.lua    | 2 +-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2ab9d77..d7fe4b6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,9 @@ Changelog](https://keepachangelog.com/en/1.0.0/), this project uses date-based
 
 ## [Unreleased]
 
+### Changed
+- Improvement to man file, `SYNOPSIS` section
+
 ## [2024-04-03]
 
 ### Changed
diff --git a/build.lua b/build.lua
index 3e6b276..5caebc5 100644
--- a/build.lua
+++ b/build.lua
@@ -22,7 +22,7 @@ function  docinit_hook()
   insert(man_t,'.TH ' .. string.upper(module) .. ' 1 "'
     .. readme:sub(date_start,date_end) .. '" "LaTeX"\n')
   insert(man_t,(".SH NAME\n" .. module .. "\n"))
-  insert(man_t,(".SH SYNOPSIS\n Usage " .. module .. " <cmd> [<options>] [<args>]\n"))
+  insert(man_t,(".SH SYNOPSIS\n" .. module .. " <cmd> [<options>] [<args>]\n"))
   insert(man_t,".SH DESCRIPTION")
 
   local _,desc_start = find(readme,"## Overview")





More information about the latex3-commits mailing list.