[PATCH] Fix minor typos

[PATCH] Fix minor typos

[Colin Woodbury]

[-- Attachment #1: Type: text/plain, Size: 258 bytes --]

Hi all, this is my first patch to Guile. I have a few more planned, but 
figured I'd throw this in first to get my feet wet with the development 
process here.

Detailed comments regarding the typo fixes are included in the patch's 
commit message.

Cheers!

[-- Attachment #2: 0001-doc-Fix-minor-typos.patch --]
[-- Type: text/x-patch, Size: 1949 bytes --]

From 5ba770e685aefc26e8554ccb327bce9fbb39acce Mon Sep 17 00:00:00 2001
From: Colin Woodbury <colin@fosskers.ca>
Date: Wed, 30 Nov 2022 09:24:06 +0900
Subject: [PATCH] doc: Fix minor typos

The spelling mistake is a clear fix, but the Arrays fix might not be as
obvious. Previously, with the "arrays" alias, the @ref macro would
render a superfluous period after the word "arrays", rendering (at least
within Emacs) as:

  you may wish to use see arrays. instead.

Notice also the superflous "see" also somehow added by @ref. That fix
should generally be included elsewhere, since it affects many more
locations, some of which expect the word "see" to appear magically, and
some which don't.
---
 doc/ref/api-data.texi     | 2 +-
 doc/ref/srfi-modules.texi | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/ref/api-data.texi b/doc/ref/api-data.texi
index 8658b9785..30190f315 100644
--- a/doc/ref/api-data.texi
+++ b/doc/ref/api-data.texi
@@ -6136,7 +6136,7 @@ accessed element in the list.
 
 Vectors can contain any kind of Scheme object; it is even possible to
 have different types of objects in the same vector.  For vectors
-containing vectors, you may wish to use @ref{Arrays,arrays} instead.
+containing vectors, you may wish to use @ref{Arrays} instead.
 Note, too, that vectors are a special case of one dimensional
 non-uniform arrays and that array procedures operate happily on vectors.
 
diff --git a/doc/ref/srfi-modules.texi b/doc/ref/srfi-modules.texi
index bce5b4eac..0ef136215 100644
--- a/doc/ref/srfi-modules.texi
+++ b/doc/ref/srfi-modules.texi
@@ -6077,7 +6077,7 @@ be used to generalize something like @code{tsegment}:
 @deffnx {Scheme Procedure} tfold reducer seed
 
 A folding transducer that yields the result of @code{(reducer seed
-value)}, saving it's result between iterations.
+value)}, saving its result between iterations.
 
 @example
 (list-transduce (tfold +) rcons (iota 10))
-- 
2.38.1

Re: [PATCH] Fix minor typos

[Aleix Conchillo Flaqué]

[-- Attachment #1: Type: text/plain, Size: 507 bytes --]

Hi!

On Wed, Nov 30, 2022 at 5:48 AM Colin Woodbury <colin_woodbury@caddi.jp>
wrote:

> Hi all, this is my first patch to Guile. I have a few more planned, but
> figured I'd throw this in first to get my feet wet with the development
> process here.
>
> Detailed comments regarding the typo fixes are included in the patch's
> commit message.
>
> Cheers!
>


On the website this looks OK:

https://www.gnu.org/software/guile/manual/html_node/Vectors.html

Did you try to generate the manual in HTML?

Aleix

[-- Attachment #2: Type: text/html, Size: 1620 bytes --]

Re: [PATCH] Fix minor typos

[Colin Woodbury]

[-- Attachment #1: Type: text/plain, Size: 333 bytes --]

Hi!

>
> On the website this looks OK:
>
> https://www.gnu.org/software/guile/manual/html_node/Vectors.html
>
> Did you try to generate the manual in HTML?
>
> Aleix

I didn't (does `make info` do that?); I mainly consume the Guide within 
Emacs itself. Interesting also that the "see" bug doesn't appear in the 
web version either.

[-- Attachment #2: Type: text/html, Size: 1781 bytes --]

Re: [PATCH] Fix minor typos

[Aleix Conchillo Flaqué]

[-- Attachment #1: Type: text/plain, Size: 501 bytes --]

On Wed, Nov 30, 2022 at 5:04 PM Colin Woodbury <colin@fosskers.ca> wrote:

> Hi!
>
>
> On the website this looks OK:
>
> https://www.gnu.org/software/guile/manual/html_node/Vectors.html
>
> Did you try to generate the manual in HTML?
>
> Aleix
>
>
> I didn't (does `make info` do that?); I mainly consume the Guide within
> Emacs itself. Interesting also that the "see" bug doesn't appear in the web
> version either.
>

`make html` should do it. The output is in doc/ref/guile.html/index.html

Aleix

[-- Attachment #2: Type: text/html, Size: 2134 bytes --]

Re: [PATCH] Fix minor typos

[Colin Woodbury]

[-- Attachment #1: Type: text/plain, Size: 370 bytes --]

> `make html` should do it. The output is in doc/ref/guile.html/index.html

Yup, that does it. For my future doc improvements I'll make sure to 
check both sides.

So it seems that both the extra period and the superfluous "see" are 
perhaps bugs in Info itself. At least when you open the Guile Guide in 
Emacs, are you able to visually confirm what I'm seeing?

Colin

[-- Attachment #2: Type: text/html, Size: 880 bytes --]

Re: [PATCH] Fix minor typos

[Aleix Conchillo Flaqué]

[-- Attachment #1: Type: text/plain, Size: 569 bytes --]

On Thu, Dec 1, 2022 at 10:10 PM Colin Woodbury <colin@fosskers.ca> wrote:

> `make html` should do it. The output is in doc/ref/guile.html/index.html
>
> Yup, that does it. For my future doc improvements I'll make sure to check
> both sides.
>
> So it seems that both the extra period and the superfluous "see" are
> perhaps bugs in Info itself. At least when you open the Guile Guide in
> Emacs, are you able to visually confirm what I'm seeing?
>
Yes, confirmed. I just tried your fix and it looks good both in info and
html.

LGTM if someone can commit this.

Aleix

[-- Attachment #2: Type: text/html, Size: 1676 bytes --]

Re: [PATCH] Fix minor typos

[Mikael Djurfeldt]

[-- Attachment #1: Type: text/plain, Size: 791 bytes --]

Thanks Colin and Aleix,

This has been committed (856c3f96).

Best regards,
Mikael

On Fri, Dec 2, 2022 at 6:44 PM Aleix Conchillo Flaqué <aconchillo@gmail.com>
wrote:

> On Thu, Dec 1, 2022 at 10:10 PM Colin Woodbury <colin@fosskers.ca> wrote:
>
>> `make html` should do it. The output is in doc/ref/guile.html/index.html
>>
>> Yup, that does it. For my future doc improvements I'll make sure to check
>> both sides.
>>
>> So it seems that both the extra period and the superfluous "see" are
>> perhaps bugs in Info itself. At least when you open the Guile Guide in
>> Emacs, are you able to visually confirm what I'm seeing?
>>
> Yes, confirmed. I just tried your fix and it looks good both in info and
> html.
>
> LGTM if someone can commit this.
>
> Aleix
>

[-- Attachment #2: Type: text/html, Size: 2215 bytes --]