Skip to content

Commit 2186020

Browse files
authored
Add new make lint command in the doc. (#741)
* Add new make lint command in the doc. * Rename rST to the formal abbreviation reST for reStructuredText
1 parent f31b08e commit 2186020

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

Diff for: README.rst

+11-5
Original file line numberDiff line numberDiff line change
@@ -138,12 +138,18 @@ the PSF for inclusion in the documentation.
138138

139139
poedit glossary.po
140140

141-
3. 存檔以後,執行以下列指令編譯輸出文件,以確保你的修改沒有 rST 的語法錯誤或警告 ::
141+
3. 存檔以後,執行以下列指令編譯輸出完整文件,以確保你的修改沒有 reST 的語法錯誤或警告 ::
142142

143143
VERSION=3.12 make all
144144

145+
或者只想快速檢查是否有 reST 語法錯誤 ::
146+
147+
VERSION=3.12 make lint
148+
149+
確保輸出中沒有任何關於正在翻譯的檔案的警告訊息。
150+
145151
如果你還沒有執行 `維護、預覽`_ 的 clone CPython 的動作,此指令會自動幫你 clone CPython,\
146-
並且會使用 Sphinx 幫你檢查 rST 語法錯誤,我們盡量保持沒有 warning \
152+
並且會使用 Sphinx 幫你檢查 reST 語法錯誤,我們盡量保持沒有 warning \
147153
的狀態,因此如果有出現 warning 的話請修復它。另外也記得檢查是否符合\
148154
`翻譯守則`_
149155

@@ -252,11 +258,11 @@ po 檔皆為首要的翻譯對象。你也可以幫忙校對已經翻譯過的
252258
- 在本情況使用 ``zip(*[iter(x)]*n)`` 是很常見的情況(Python 慣例)。
253259
- 在超文件標示語言 (HTML) 中應注意跳脫符號。
254260

255-
rST 語法注意事項
261+
reST 語法注意事項
256262
----------------
257263

258-
- ``:xxx:`...``` 即為 rST 的語法,應該在譯文中保留。
259-
- rST 諸多語法需要保留前後的空白。在中文裡,該空白可以用 :literal:`\\\ \ `
264+
- ``:xxx:`...``` 即為 reST 的語法,應該在譯文中保留。
265+
- reST 諸多語法需要保留前後的空白。在中文裡,該空白可以用 :literal:`\\\ \ `
260266
來取代,製造一個沒有寬度的分隔符號。
261267

262268
例如:

0 commit comments

Comments
 (0)