algorithm/hello-algo
1
0
Fork 0
mirror of https://github.com/krahets/hello-algo.git synced 2025-07-15 04:38:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Use underline format for the technical terms (#1213)

Browse Source 
* Use underline format for the technical terms

* Bug fixes
This commit is contained in:
Yudong Jin
2024-04-03 03:52:17 +08:00
committed by GitHub
parent 06068927cd
commit 2b1a98fb61
42 changed files with 105 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
en/docs/chapter_preface/suggestions.md
View File

@ -7,10 +7,10 @@
## Writing Conventions
- Chapters marked with '*' after the title are optional and contain relatively challenging content. If you are short on time, it is advisable to skip them.
- Key technical terms and their English equivalents are enclosed in **Bold** + *italics* brackets, for example, ***array***. It's advisable to familiarize yourself with these for better comprehension of technical texts.
- Proprietary terms and words with specific meanings are indicated with “quotation marks” to avoid ambiguity.
- Technical terms will be in boldface (in the print and PDF versions) or underlined (in the web version), for instance, <u>array</u>. It's advisable to familiarize yourself with these for better comprehension of technical texts.
- **Bolded text** indicates key content or summary statements, which deserve special attention.
- When it comes to terms that are inconsistent between programming languages, this book follows Python, for example using $\text{None}$ to mean "null".
- Words and phrases with specific meanings are indicated with “quotation marks” to avoid ambiguity.
- When it comes to terms that are inconsistent between programming languages, this book follows Python, for example using `None` to mean `null`.
- This book partially ignores the comment conventions for programming languages in exchange for a more compact layout of the content. The comments primarily consist of three types: title comments, content comments, and multi-line comments.
=== "Python"