[PATCH] Minor docs fixes

[Ryan Davis]

Thanks for the feedback Yaroslav! Updated patch is attached with the suggested commit log, whitespace, and `rev` changes.

Thanks,


[signature_3506516580]<https://www.nginx.com/>
Ryan Davis | Sr Software Engineer


From: nginx-devel <nginx-devel-bounces at nginx.org> on behalf of Yaroslav Zhuravlev <yar at nginx.com>
Date: Thursday, August 31, 2023 at 5:26 PM
To: nginx-devel at nginx.org <nginx-devel at nginx.org>
Subject: Re: [PATCH] Minor docs fixes
EXTERNAL MAIL: nginx-devel-bounces at nginx.org

Hi,

> On 31 Aug 2023, at 21:43, Sergey A. Osokin <osa at freebsd.org.ru> wrote:
>
> Hi,
>
> here's the patch from Ryan.
>
> On Thu, Aug 31, 2023 at 08:31:34PM +0000, Ryan Davis via nginx-devel wrote:
>> Apologies, the corporate SMTP server is doing something unexpected.
>
> # HG changeset patch
> # User Ryan Davis <ry.davis at f5.com>
> # Date 1693509279 14400
> #      Thu Aug 31 15:14:39 2023 -0400
> # Node ID 31eebaba6f8d4973c35c40f3da69c9d9fe598438
> # Parent  4e25281328fa2152cadedc52e05f8a1b1bf531cd
> Minor docs fixes

Perhaps a more descriptive commit log would be better, e.g.
"Fixed lang attribute, added module closing tag."

>
> - add a missing close tag that tripped up non-streaming XML parsers
> - fix a misclassified `lang` attribute
>
> diff -r 4e25281328fa -r 31eebaba6f8d xml/en/docs/http/ngx_http_api_module_head.xml
> --- a/xml/en/docs/http/ngx_http_api_module_head.xml Tue Aug 29 09:11:57 2023 +0100
> +++ b/xml/en/docs/http/ngx_http_api_module_head.xml Thu Aug 31 15:14:39 2023 -0400
> @@ -9,7 +9,7 @@
> <module name="Module ngx_http_api_module"
>         link="/en/docs/http/ngx_http_api_module.html"
>         lang="en"
> -        rev="3">
> +        rev="4">
>
> <section id="summary">
>
> @@ -298,3 +298,4 @@
> </para>
>
> </section>

Blank line missing between section and module tags.

> +</module>
> diff -r 4e25281328fa -r 31eebaba6f8d xml/ru/docs/http/ngx_http_v3_module.xml
> --- a/xml/ru/docs/http/ngx_http_v3_module.xml Tue Aug 29 09:11:57 2023 +0100
> +++ b/xml/ru/docs/http/ngx_http_v3_module.xml Thu Aug 31 15:14:39 2023 -0400
> @@ -8,8 +8,8 @@
>
> <module name="Модуль ngx_http_v3_module"
>         link="/ru/docs/http/ngx_http_v3_module.html"
> -        lang="en"
> -        rev="2">
> +        lang="ru"
> +        rev="3">

Version bump should also be applied to the En version as well as they correspond to each other.
Or it might be better not to bump the version at all here as the change is small and not content related.

>
> <section id="summary">
>
>
> --
> Sergey A. Osokin
> _______________________________________________
> nginx-devel mailing list
> nginx-devel at nginx.org
> https://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fmailman.nginx.org%2Fmailman%2Flistinfo%2Fnginx-devel&data=05%7C01%7Cry.davis%40f5.com%7C1b07ff05f87e41444cac08dbaa68e1d2%7Cdd3dfd2f6a3b40d19be0bf8327d81c50%7C0%7C0%7C638291139671112762%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=AriByeciwGYwHqdfP36a5yoaicPkQlule1QoFF9iugk%3D&reserved=0<https://mailman.nginx.org/mailman/listinfo/nginx-devel>
_______________________________________________
nginx-devel mailing list
nginx-devel at nginx.org
https://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fmailman.nginx.org%2Fmailman%2Flistinfo%2Fnginx-devel&data=05%7C01%7Cry.davis%40f5.com%7C1b07ff05f87e41444cac08dbaa68e1d2%7Cdd3dfd2f6a3b40d19be0bf8327d81c50%7C0%7C0%7C638291139671112762%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=AriByeciwGYwHqdfP36a5yoaicPkQlule1QoFF9iugk%3D&reserved=0<https://mailman.nginx.org/mailman/listinfo/nginx-devel>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mailman.nginx.org/pipermail/nginx-devel/attachments/20230901/2e731f1f/attachment-0001.htm>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image001.png
Type: image/png
Size: 7040 bytes
Desc: image001.png
URL: <http://mailman.nginx.org/pipermail/nginx-devel/attachments/20230901/2e731f1f/attachment-0001.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: docs.diff
Type: application/octet-stream
Size: 1205 bytes
Desc: docs.diff
URL: <http://mailman.nginx.org/pipermail/nginx-devel/attachments/20230901/2e731f1f/attachment-0001.obj>