Linux Documentation
 help / color / mirror / Atom feed
From: Jiandong Qiu <qiujiandong1998@gmail.com>
To: Weijie Yuan <wy@wyuan.org>, alexs@kernel.org, si.yanteng@linux.dev
Cc: dzm91@hust.edu.cn, corbet@lwn.net, skhan@linuxfoundation.org,
	 linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 0/2] docs/zh_CN: update translations for process/changes.rst and sphinx.rst
Date: Sun, 5 Jul 2026 23:20:30 +0800	[thread overview]
Message-ID: <akpxuLXKrbN7qB9o@archlinux> (raw)
In-Reply-To: <akn4oYmihmNHFOY7@wyuan.org>

On Sun, Jul 05, 2026 at 02:24:33PM +0800, Weijie Yuan wrote:
> One minor readability concern I noticed in both patches is that some
> simple tables mix CJK text with ASCII table markup. (correct me if I'm
> wrong) Which are, patch 1/2 adds the "当前最低需求" table in
> process/changes.rst, and patch 2/2 adds the tables under
> "数学渲染器的选择" and "设置 SPHINX_IMGMATH 的效果" in
> doc-guide/sphinx.rst.
> 
> These tables may look aligned with an East-Asian-width-aware
> font/editor, but the column boundaries can look misaligned in some other
> fonts, mail readers, or editors when reading the plain .rst source. For
> example, the lore archive itself.
> ...
> But I'm not familiar with rst and have never delved into fonts, it may
> be better to ask maintainers to reach an agreement.

Thanks for the Weijie's careful review and the readability suggestion.

```rst
====================== ===============  ====================
        程序               最低版本         版本检查命令
====================== ===============  ====================
bc                     1.06.95          bc --version
bindgen(可选)        0.65.1           bindgen --version
binutils               2.30             ld -v
```

Like the code above, the line with "可选" is misaligned in lore archive.
I agree that in plain .rst source, mixing CJK text with ASCII table markup
can look misaligned without a proper 2:1 width monospace font. However,
a few clarifications:

1. The rendered HTML documentation displays these as standard bordered
tables, so there's no issue there.

2. The real problem is the lore archive's rendering, which apparently
doesn't use a CJK-aware monospace font for source display.

3. In my local environment, I use Maple Mono NF CN (a font with perfect
2:1 CJK/ASCII width ratio), so everything aligns correctly.

IMO, this is a minor issue that doesn't affect actual patch review,
as reviewers can pull the patch locally and view it with a proper font.
A fundamental fix, if needed, would be improving lore archive's rendering
rather than adjusting individual tables.

I'd like to hear the maintainers' opinion on this.

Thanks,
Jiandong

  reply	other threads:[~2026-07-05 15:20 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-06-21 13:12 [PATCH v2 0/2] docs/zh_CN: update translations for process/changes.rst and sphinx.rst Jiandong Qiu
2026-06-21 13:12 ` [PATCH v2 1/2] docs/zh_CN: add process/changes.rst translation Jiandong Qiu
2026-07-05  8:23   ` Dongliang Mu
2026-07-05 15:48     ` Jiandong Qiu
2026-06-21 13:12 ` [PATCH v2 2/2] docs/zh_CN: update sphinx.rst translation Jiandong Qiu
2026-07-05  6:24 ` [PATCH v2 0/2] docs/zh_CN: update translations for process/changes.rst and sphinx.rst Weijie Yuan
2026-07-05 15:20   ` Jiandong Qiu [this message]
2026-07-05 15:51     ` Weijie Yuan
2026-07-06 13:21       ` Jiandong Qiu

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=akpxuLXKrbN7qB9o@archlinux \
    --to=qiujiandong1998@gmail.com \
    --cc=alexs@kernel.org \
    --cc=corbet@lwn.net \
    --cc=dzm91@hust.edu.cn \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=si.yanteng@linux.dev \
    --cc=skhan@linuxfoundation.org \
    --cc=wy@wyuan.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox