public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: YanTeng Si <si.yanteng@linux.dev>
To: Akira Yokosawa <akiyks@gmail.com>, dzm91@hust.edu.cn, seakeel@gmail.com
Cc: corbet@lwn.net, hust-os-kernel-patches@googlegroups.com,
	justinstitt@google.com, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, llvm@lists.linux.dev,
	morbo@google.com, nathan@kernel.org, ndesaulniers@google.com,
	siyanteng@loongson.cn, alexs@kernel.org
Subject: Re: [PATCH v2] docs/zh_CN: add the translation of kbuild/gcc-plugins.rst
Date: Mon, 2 Sep 2024 09:32:08 +0800	[thread overview]
Message-ID: <65f5467a-5c31-4d35-b0a4-e163429e98c9@linux.dev> (raw)
In-Reply-To: <58b7c7d2-f60c-4a2d-9cb5-d583182bfef4@gmail.com>




在 2024/9/1 14:03, Akira Yokosawa 写道:
> Hi,
>
> I'm not Alex, but let me chime in.
>
> On Sat, 31 Aug 2024 17:34:11 +0800, Dongliang Mu wrote:
>> On 2024/8/31 12:11, Alex Shi wrote:
>>> On 8/31/24 11:48 AM, Dongliang Mu wrote:
>>>> +目的
>>>> +=======
>>>> +
>>> there are still a lots of sign incorrect. Please be sure everything looks fine in a web browser after you 'make htmldocs'
>> What do you mean by "sign incorrect"? I check the html rendering in the
>> vscode. It seems fine to me.
> You are right.  There is nothing wrong as far as the reST specification
> is concerned.
>
> Quote from https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#sections
> (emphasis by me):
>
>      An underline/overline is a single repeated punctuation character that
>      begins in column 1 and forms a line extending *at least* as far as the
>      right edge of the title text.
Yes, I guess we should also think about the reading experience
of readers who use vim to read kernel documentation.

Because Chinese characters are already very neat, sentences
and paragraphs should also be neat, otherwise the reading
experience will be poor.

Let's take a look at some examples: (copy to vim)

整齐
====
整齐
====
整齐
====
Great!


And


不整齐
============
不整齐
=========
不整齐
================
I think this is a bit difficult to read. What do you think?



Thanks,
Yanteng
> HTH, Akira
>
>> Dongliang Mu
>


  parent reply	other threads:[~2024-09-02  1:32 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-31  3:48 [PATCH v2] docs/zh_CN: add the translation of kbuild/gcc-plugins.rst Dongliang Mu
2024-08-31  4:11 ` Alex Shi
2024-08-31  9:34   ` Dongliang Mu
2024-09-01  6:03     ` Akira Yokosawa
2024-09-01 10:38       ` Dongliang Mu
2024-09-02  1:32       ` YanTeng Si [this message]
2024-09-02  3:21         ` Akira Yokosawa
2024-09-02  6:07           ` YanTeng Si
2024-09-02  7:12     ` Alex Shi

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=65f5467a-5c31-4d35-b0a4-e163429e98c9@linux.dev \
    --to=si.yanteng@linux.dev \
    --cc=akiyks@gmail.com \
    --cc=alexs@kernel.org \
    --cc=corbet@lwn.net \
    --cc=dzm91@hust.edu.cn \
    --cc=hust-os-kernel-patches@googlegroups.com \
    --cc=justinstitt@google.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=llvm@lists.linux.dev \
    --cc=morbo@google.com \
    --cc=nathan@kernel.org \
    --cc=ndesaulniers@google.com \
    --cc=seakeel@gmail.com \
    --cc=siyanteng@loongson.cn \
    /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