Skip to content

Commit 46fd2f4

Browse files
wh131462wh131462
committed
docs(readme): refine documentation content writing
1 parent 12a2e41 commit 46fd2f4

File tree

5 files changed

+60
-55
lines changed

5 files changed

+60
-55
lines changed

‎CODE_OF_CONDUCT.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,24 @@ diverse, inclusive, and healthy community.
1717
Examples of behavior that contributes to a positive environment for our
1818
community include:
1919

20-
* Demonstrating empathy and kindness toward other people
21-
* Being respectful of differing opinions, viewpoints, and experiences
22-
* Giving and gracefully accepting constructive feedback
23-
* Accepting responsibility and apologizing to those affected by our mistakes,
24-
and learning from the experience
25-
* Focusing on what is best not just for us as individuals, but for the
26-
overall community
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
2727

2828
Examples of unacceptable behavior include:
2929

30-
* The use of sexualized language or imagery, and sexual attention or
31-
advances of any kind
32-
* Trolling, insulting or derogatory comments, and personal or political attacks
33-
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email
35-
address, without their explicit permission
36-
* Other conduct which could reasonably be considered inappropriate in a
37-
professional setting
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
3838

3939
## Enforcement Responsibilities
4040

@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
106106
### 4. Permanent Ban
107107

108108
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
109+
standards, including sustained inappropriate behavior, harassment of an
110110
individual, or aggression toward or disparagement of classes of individuals.
111111

112112
**Consequence**: A permanent ban from any sort of public interaction within

‎README.md

+14-12
Original file line numberDiff line numberDiff line change
@@ -232,12 +232,12 @@ npm i -D leetcode-practice
232232

233233
#### [1]. lk
234234

235-
| Short Parameter | Full Parameter | Explanation |
236-
| ---------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
237-
| No parameter / `-t` | `--today` | Check today's daily question |
238-
| Question number / `-i` | `--identity` | Check the question corresponding to the specified number, and check if the question with the specified ID exists in the current working directory |
239-
| `-r` | `--random` | Check the question created using the random mode last time |
240-
| `-e` | `--easy` | Interactive check of the corresponding question based on prompts |
235+
| Short Parameter | Full Parameter | Explanation |
236+
| --------------------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
237+
| No parameter / `-t` | `--today` | Check today's daily question |
238+
| Question number / `-i <identity>` | `--identity <identity>` | Check the question corresponding to the specified number, and check if the question with the specified ID exists in the current working directory |
239+
| `-r` | `--random` | Check the question created using the random mode last time |
240+
| `-e` | `--easy` | Interactive check of the corresponding question based on prompts |
241241

242242
> Note: When checking, please pay attention to what mode to use for checking, and make sure that you have performed the corresponding mode creation operation.
243243
> The specified ID mode is an exception because it will check whether the specified ID exists in the current working directory.
@@ -250,19 +250,21 @@ npm i -D leetcode-practice
250250

251251
#### [3]. lc
252252

253-
| Short Parameter | Full Parameter | Explanation |
254-
| ---------------------- | -------------- | ----------------------------------------------------------------------- |
255-
| No parameter / `-t` | `--today` | Create today's daily question |
256-
| Question number / `-i` | `--identity` | Create the question corresponding to the specified number |
257-
| `-r` | `--random` | Create a random question that has not appeared in the current directory |
258-
| `-e` | `--easy` | Interactive creation of questions |
253+
| Short Parameter | Full Parameter | Explanation |
254+
| --------------------------------- | ----------------------- | --------------------------------------------------------------------------------------- |
255+
| No parameter / `-t` | `--today` | Create today's daily question |
256+
| Question number / `-i <identity>` | `--identity <identity>` | Create the question corresponding to the specified number |
257+
| `-r` | `--random` | Create a random question that has not appeared in the current directory |
258+
| `-e` | `--easy` | Interactive creation of questions |
259+
| `-a` | `--all` | Fetch all questions from server and store them locally, prepare database for lf command |
259260

260261
#### [4]. General Parameters
261262

262263
| Short Parameter | Full Parameter | Explanation |
263264
| ---------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
264265
| `-d <directory>` | `--directory <directory>` | Specify the working directory (a relative address of the current execution directory), which will affect the creation and checking |
265266
| `-V` | `--version` | Check the version number |
267+
| `-v` | `--ver` | Check the version info and some extra info about leetcode-practice |
266268
| `-h` | `--help` | Get help information |
267269
| `-l [language]` | `--language [language]` | Without specifying a parameter, get the current language environment (default is JavaScript). Specifying a parameter can set the language environment to the corresponding language (e.g., `-l java` sets the language environment to Java) |
268270
| `-u` | `--update` | Update the current script or dependency |

‎README_CN.md

+14-12
Original file line numberDiff line numberDiff line change
@@ -237,12 +237,12 @@ npm i -D leetcode-practice
237237

238238
#### [1].lk
239239

240-
| 简单参数 | 完整参数 | 说明 |
241-
| ------------- | ------------ | ---------------------------------------------------------------------- |
242-
| 无参数/`-t` | `--today` | 检查今日的每日一题 |
243-
| 题目编号/`-i` | `--identity` | 检查指定编号对应的题目，会检查当前工作目录下的是否存在指定id对应的题目 |
244-
| `-r` | `--random` | 检查上一次使用随机模式创建的题目 |
245-
| `-e` | `--easy` | 交互式的根据提示去检查对应的题目 |
240+
| 简单参数 | 完整参数 | 说明 |
241+
| ------------------------ | ----------------------- | ---------------------------------------------------------------------- |
242+
| 无参数/`-t` | `--today` | 检查今日的每日一题 |
243+
| 题目编号/`-i <identity>` | `--identity <identity>` | 检查指定编号对应的题目，会检查当前工作目录下的是否存在指定id对应的题目 |
244+
| `-r` | `--random` | 检查上一次使用随机模式创建的题目 |
245+
| `-e` | `--easy` | 交互式的根据提示去检查对应的题目 |
246246

247247
> 注意: 当你检测的时候需要注意，使用什么模式去检查，请确保你已经执行过对应模式的创建操作。
248248
> 指定编号模式除外，因为会优先检查指定的id是否在当前工作目录存在。
@@ -255,19 +255,21 @@ npm i -D leetcode-practice
255255

256256
#### [3].lc
257257

258-
| 简单参数 | 完整参数 | 说明 |
259-
| ------------- | ------------ | -------------------------------- |
260-
| 无参数/`-t` | `--today` | 创建今日的每日一题 |
261-
| 题目编号/`-i` | `--identity` | 创建指定编号对应的题目 |
262-
| `-r` | `--random` | 创建当前目录下未出现过的随机题目 |
263-
| `-e` | `--easy` | 交互式创建题目 |
258+
| 简单参数 | 完整参数 | 说明 |
259+
| ------------------------ | ----------------------- | -------------------------------- |
260+
| 无参数/`-t` | `--today` | 创建今日的每日一题 |
261+
| 题目编号/`-i <identity>` | `--identity <identity>` | 创建指定编号对应的题目 |
262+
| `-r` | `--random` | 创建当前目录下未出现过的随机题目 |
263+
| `-e` | `--easy` | 交互式创建题目 |
264+
| `-a` | `--all` | 获取全部题目缓存,用于lf指令 |
264265

265266
#### [4].通用参数
266267

267268
| 简单参数 | 完整参数 | 说明 |
268269
| ---------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
269270
| `-d <directory>` | `--directory <directory>` | 指定工作目录(是一个当前执行目录的相对地址)，会影响创建和检查 |
270271
| `-V` | `--version` | 检查版本号 |
272+
| `-v` | `--ver` | 检查版本号信息并且输出一些额外的信息 |
271273
| `-h` | `--help` | 获取帮助信息 |
272274
| `-l [language]` | `--language [language]` | 不指定参数为获取当前的语言环境(默认为javascript),指定参数可以设置语言环境为对应语言(如`-l java`可以指定语言环境为java) |
273275
| `-u` | `--update` | 更新当前脚本或者依赖 |

‎README_JP.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -228,12 +228,12 @@ npm i -D leetcode-practice
228228

229229
#### [1]. lk (問題のチェック)
230230

231-
| 簡易パラメータ | 完全パラメータ | 説明 |
232-
| -------------- | -------------- | ------------------------------------------------------------------------------------------------------------------ |
233-
| 無し/`-t` | `--today` | 今日の毎日の問題をチェックします。 |
234-
| 問題番号/`-i` | `--identity` | 指定された番号に対応する問題をチェックします。指定されたIDが現在の作業ディレクトリに存在するかどうかも確認します。 |
235-
| `-r` | `--random` | 最後に使用されたランダムモードで作成された問題をチェックします。 |
236-
| `-e` | `--easy` | インタラクティブにプロンプトに従って問題をチェックします。 |
231+
| 簡易パラメータ | 完全パラメータ | 説明 |
232+
| ------------------------ | ----------------------- | ------------------------------------------------------------------------------------------------------------------ |
233+
| 無し/`-t` | `--today` | 今日の毎日の問題をチェックします。 |
234+
| 問題番号/`-i <identity>` | `--identity <identity>` | 指定された番号に対応する問題をチェックします。指定されたIDが現在の作業ディレクトリに存在するかどうかも確認します。 |
235+
| `-r` | `--random` | 最後に使用されたランダムモードで作成された問題をチェックします。 |
236+
| `-e` | `--easy` | インタラクティブにプロンプトに従って問題をチェックします。 |
237237

238238
> 注意: チェックする際は、どのモードを使用するかに注意してください。対応するモードの作成操作をすでに実行したことを確認してください。
239239
> 指定番号モードは例外であり、作成されていない問題をチェックすることもできます。
@@ -246,19 +246,20 @@ npm i -D leetcode-practice
246246

247247
#### [3]. lc (問題の作成)
248248

249-
| 簡易パラメータ | 完全パラメータ | 説明 |
250-
| -------------- | -------------- | -------------------------------------------- |
251-
| 無し/`-t` | `--today` | 今日の毎日の問題を作成します。 |
252-
| 問題番号/`-i` | `--identity` | 指定された番号に対応する問題を作成します。 |
253-
| `-r` | `--random` | まだ現れていないランダムな問題を作成します。 |
254-
| `-e` | `--easy` | インタラクティブに問題を作成します。 |
249+
| 簡易パラメータ | 完全パラメータ | 説明 |
250+
| ------------------------ | ----------------------- | -------------------------------------------- |
251+
| 無し/`-t` | `--today` | 今日の毎日の問題を作成します。 |
252+
| 問題番号/`-i <identity>` | `--identity <identity>` | 指定された番号に対応する問題を作成します。 |
253+
| `-r` | `--random` | まだ現れていないランダムな問題を作成します。 |
254+
| `-e` | `--easy` | インタラクティブに問題を作成します。 |
255255

256256
#### [4]. 汎用パラメータ
257257

258258
| 簡易パラメータ | 完全パラメータ | 説明 |
259259
| ---------------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
260260
| `-d <directory>` | `--directory <directory>` | 作業ディレクトリを指定します（現在の実行ディレクトリの相対パス）。これは作成とチェックの両方に影響を与えます。 |
261261
| `-V` | `--version` | バージョン番号を確認します。 |
262+
| `-v` | `--ver` | Leetcode-practice のバージョン情報と追加情報をチェックする |
262263
| `-h` | `--help` | ヘルプ情報を取得します。 |
263264
| `-l [language]` | `--language [language]` | パラメータなしで現在の言語環境を取得します（デフォルトはJavaScript）。言語を指定すると、その言語の環境が設定されます（たとえば、`-l java`でJavaの環境が設定されます）。 |
264265
| `-u` | `--update` | 現在のスクリプトまたは依存関係を更新します。 |

0 commit comments

Comments
 (0)