bug#40215: [PATCH 0/4] A few minor documentation fixes and improvements

bug#40215: [PATCH 0/4] A few minor documentation fixes and improvements

[Arun Isaac]

A few minor documentation fixes and improvements follow.

Arun Isaac (4):
  doc: Fix minor typo in the HTTP headers documentation.
  doc: Improve content-range HTTP header documentation.
  doc: Document default delimiter of string-join.
  doc: Mention (ice-9 time) module path.

 doc/ref/api-data.texi     |  7 ++++---
 doc/ref/scheme-using.texi |  3 +++
 doc/ref/web.texi          | 10 +++++-----
 3 files changed, 12 insertions(+), 8 deletions(-)

-- 
2.25.1

bug#40215: [PATCH 1/4] doc: Fix minor typo in the HTTP headers documentation.

[Arun Isaac]

* doc/ref/web.texi (HTTP Headers): Fix minor typo.
---
 doc/ref/web.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/ref/web.texi b/doc/ref/web.texi
index 2d07dd7b1..31630def7 100644
--- a/doc/ref/web.texi
+++ b/doc/ref/web.texi
@@ -774,7 +774,7 @@ The MD5 digest of a resource.
 @deftypevr {HTTP Header} List content-range
 A range specification, as a list of three elements: the symbol
 @code{bytes}, either the symbol @code{*} or a pair of integers,
-indicating the byte rage, and either @code{*} or an integer, for the
+indicating the byte range, and either @code{*} or an integer, for the
 instance length.  Used to indicate that a response only includes part of
 a resource.
 @example
-- 
2.25.1

bug#40215: [PATCH 2/4] doc: Improve content-range HTTP header documentation.

[Arun Isaac]

* doc/ref/web.texi (HTTP Headers): Improve punctuation in content-range
HTTP header documentation.
---
 doc/ref/web.texi | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/doc/ref/web.texi b/doc/ref/web.texi
index 31630def7..93cd0214f 100644
--- a/doc/ref/web.texi
+++ b/doc/ref/web.texi
@@ -772,11 +772,11 @@ The MD5 digest of a resource.
 @end deftypevr
 
 @deftypevr {HTTP Header} List content-range
-A range specification, as a list of three elements: the symbol
-@code{bytes}, either the symbol @code{*} or a pair of integers,
-indicating the byte range, and either @code{*} or an integer, for the
-instance length.  Used to indicate that a response only includes part of
-a resource.
+Range specification as a list of three elements: the symbol
+@code{bytes}, either the symbol @code{*} or a pair of integers
+indicating the byte range, and either @code{*} or an integer indicating
+the instance length.  Used to indicate that a response only includes
+part of a resource.
 @example
 (parse-header 'content-range "bytes 10-20/*")
 @result{} (bytes (10 . 20) *)
-- 
2.25.1

bug#40215: [PATCH 3/4] doc: Document default delimiter of string-join.

[Arun Isaac]

* doc/ref/api-data.texi (String Constructors): Document default
delimiter of the string-join function.
---
 doc/ref/api-data.texi | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/doc/ref/api-data.texi b/doc/ref/api-data.texi
index a6b09c478..3dd5109c4 100644
--- a/doc/ref/api-data.texi
+++ b/doc/ref/api-data.texi
@@ -3183,9 +3183,10 @@ produce the corresponding string element.  The order in which
 @deffnx {C Function} scm_string_join (ls, delimiter, grammar)
 Append the string in the string list @var{ls}, using the string
 @var{delimiter} as a delimiter between the elements of @var{ls}.
-@var{grammar} is a symbol which specifies how the delimiter is
-placed between the strings, and defaults to the symbol
-@code{infix}.
+@var{delimiter} defaults to @w{@samp{ }}, that is, strings in @var{ls}
+are appended with the space character in between them.  @var{grammar} is
+a symbol which specifies how the delimiter is placed between the
+strings, and defaults to the symbol @code{infix}.
 
 @table @code
 @item infix
-- 
2.25.1

bug#40215: [PATCH 4/4] doc: Mention (ice-9 time) module path.

[Arun Isaac]

* doc/ref/scheme-using.texi (Profile Commands): Mention (ice-9 time)
module path.
---
 doc/ref/scheme-using.texi | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/ref/scheme-using.texi b/doc/ref/scheme-using.texi
index ac265fcca..31981cb5d 100644
--- a/doc/ref/scheme-using.texi
+++ b/doc/ref/scheme-using.texi
@@ -311,6 +311,9 @@ will be printed farther to the right, though if the width of the
 indentation passes the @var{max-indent}, the indentation is abbreviated.
 @end deffn
 
+These REPL commands can also be called as regular functions in scheme
+code on including the @code{(ice-9 time)} module.
+
 @node Debug Commands
 @subsubsection Debug Commands
 
-- 
2.25.1

bug#40215: [PATCH 0/4] A few minor documentation fixes and improvements

[Ludovic Courtès]

Hi Arun,

Arun Isaac <arunisaac@systemreboot.net> skribis:

>   doc: Fix minor typo in the HTTP headers documentation.
>   doc: Improve content-range HTTP header documentation.
>   doc: Document default delimiter of string-join.
>   doc: Mention (ice-9 time) module path.

Applied all 4 patches.  For ‘string-join’, I updated the docstring in
srfi-13.c so both are in sync.  That in turn required support for @w{…}
in the texinfo modules…

Thanks,
Ludo’.