From 703908e72bc1b410d3e4095c8e5f0cfb5772967d Mon Sep 17 00:00:00 2001 From: cschan <45995789+cschan1828@users.noreply.github.com> Date: Sat, 9 Dec 2023 18:29:00 +0800 Subject: [PATCH 1/2] Add new make lint command in the doc. --- README.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 3daa0e2672..c2cab23ac2 100644 --- a/README.rst +++ b/README.rst @@ -138,10 +138,16 @@ the PSF for inclusion in the documentation. poedit glossary.po -3. 存檔以後，執行以下列指令編譯輸出文件，以確保你的修改沒有 rST 的語法錯誤或警告 :: +3. 存檔以後，執行以下列指令編譯輸出完整文件，以確保你的修改沒有 rST 的語法錯誤或警告 :: VERSION=3.12 make all + 或者只想快速檢查是否有 rST 語法錯誤 :: + + VERSION=3.12 make lint + + 確保輸出中沒有任何關於正在翻譯的檔案的警告訊息。 + 如果你還沒有執行 `維護、預覽`_ 的 clone CPython 的動作，此指令會自動幫你 clone CPython，\ 並且會使用 Sphinx 幫你檢查 rST 語法錯誤，我們盡量保持沒有 warning \ 的狀態，因此如果有出現 warning 的話請修復它。另外也記得檢查是否符合\ From 13229e61e9eafb1a296b10971001d8d10fe76ea3 Mon Sep 17 00:00:00 2001 From: cschan <45995789+cschan1828@users.noreply.github.com> Date: Sat, 9 Dec 2023 19:34:30 +0800 Subject: [PATCH 2/2] Rename rST to the formal abbreviation reST for reStructuredText --- README.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index c2cab23ac2..03ba9b469d 100644 --- a/README.rst +++ b/README.rst @@ -138,18 +138,18 @@ the PSF for inclusion in the documentation. poedit glossary.po -3. 存檔以後，執行以下列指令編譯輸出完整文件，以確保你的修改沒有 rST 的語法錯誤或警告 :: +3. 存檔以後，執行以下列指令編譯輸出完整文件，以確保你的修改沒有 reST 的語法錯誤或警告 :: VERSION=3.12 make all - 或者只想快速檢查是否有 rST 語法錯誤 :: + 或者只想快速檢查是否有 reST 語法錯誤 :: VERSION=3.12 make lint 確保輸出中沒有任何關於正在翻譯的檔案的警告訊息。 如果你還沒有執行 `維護、預覽`_ 的 clone CPython 的動作，此指令會自動幫你 clone CPython，\ - 並且會使用 Sphinx 幫你檢查 rST 語法錯誤，我們盡量保持沒有 warning \ + 並且會使用 Sphinx 幫你檢查 reST 語法錯誤，我們盡量保持沒有 warning \ 的狀態，因此如果有出現 warning 的話請修復它。另外也記得檢查是否符合\ `翻譯守則`_ @@ -258,11 +258,11 @@ po 檔皆為首要的翻譯對象。你也可以幫忙校對已經翻譯過的 - 在本情況使用 ``zip(*[iter(x)]*n)`` 是很常見的情況（Python 慣例）。 - 在超文件標示語言 (HTML) 中應注意跳脫符號。 -rST 語法注意事項 +reST 語法注意事項 ---------------- -- ``:xxx:`...``` 即為 rST 的語法，應該在譯文中保留。 -- rST 諸多語法需要保留前後的空白。在中文裡，該空白可以用 :literal:`\\\ \ ` +- ``:xxx:`...``` 即為 reST 的語法，應該在譯文中保留。 +- reST 諸多語法需要保留前後的空白。在中文裡，該空白可以用 :literal:`\\\ \ ` 來取代，製造一個沒有寬度的分隔符號。 例如：