Skip to content

Commit e7d98c7

Browse files
authored
docs: Fix a few typos (#2764)
There are small typos in: - CONTRIBUTING.md - docs/api/options/interactions.en.md - docs/api/plots/liquid.en.md - docs/common/interactions.en.md Fixes: - Should read `outline` rather than `ouline`. - Should read `interactions` rather than `interacions`. - Should read `written` rather than `wirtten`. - Should read `reason` rather than `reasone`. - Should read `guarantee` rather than `garantee`.
1 parent 44770b4 commit e7d98c7

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ $ git checkout -b branch-name
2424
# Run the test after you finish your modification. Add new test cases or change old ones if you feel necessary
2525
$ npm test
2626

27-
# If your modification pass the tests, congradulations it's time to push your work back to us. Notice that the commit message should be wirtten in the following format.
27+
# If your modification pass the tests, congradulations it's time to push your work back to us. Notice that the commit message should be written in the following format.
2828
$ git add . # git add -u to delete files
2929
$ git commit -m "fix(role): role.use must xxx"
3030
$ git push origin branch-name
3131
```
3232

3333
Then you can create a Pull Request at [g2plot](https:// github.com/antvis/g2plot/pulls).
3434

35-
No one can garantee how much will be remembered about certain PR after some time. To make sure we can easily recap what happened previously, please provide the following information in your PR.
35+
No one can guarantee how much will be remembered about certain PR after some time. To make sure we can easily recap what happened previously, please provide the following information in your PR.
3636

3737
1. Need: What function you want to achieve (Generally, please point out which issue is related).
3838
2. Updating Reason: Different with issue. Briefly describe your reason and logic about why you need to make such modification.
@@ -79,7 +79,7 @@ Use succinct words to describe what did you do { in the } commit change.
7979

8080
(4)body
8181

82-
Feel free to add more content in the body, if you { think } subject is not self-explanatory enough, such as what it is the purpose or reasone of you commit.
82+
Feel free to add more content in the body, if you { think } subject is not self-explanatory enough, such as what it is the purpose or reason of you commit.
8383

8484
(5)footer
8585

docs/api/options/interactions.en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ more details about action, got to see [G2 | interaction feedback](https://g2.ant
4040
| element-single-highlight | 用于设置和取消图表元素的 highlight ,只允许单个元素 highlight。高亮的时候会取消当前激活元素之外的元素的高亮态 | <tag color="green" text="Element">Element</tag> |
4141
| element-filter| 图表元素的过滤,支持来自图例(分类和连续)、坐标轴文本的触发 | <tag color="green" text="Element">Element</tag> |
4242

43-
### Assembel interacions
43+
### Assembel interactions
4444

4545
#### element-link (chart elements of the same colors)
4646

docs/api/plots/liquid.en.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,13 @@ function shape(x: number, y: number, width: number, height: number) {
6666

6767
<description>**optional** _Outline_</description>
6868

69-
The ouline configure for liquid plot, includes:
69+
The outline configure for liquid plot, includes:
7070

7171
| Properties | Type | Desc |
7272
| ---------- | ----------------- | --------------------------------------------- |
73-
| border | _number_ | border width of ouline, default 2px |
74-
| distance | _number_ | distance between ouline and wave, default 0px |
75-
| style | _OutlineStyleCfg_ | the style configure of ouline |
73+
| border | _number_ | border width of outline, default 2px |
74+
| distance | _number_ | distance between outline and wave, default 0px |
75+
| style | _OutlineStyleCfg_ | the style configure of outline |
7676

7777
The style configure of outline for liquid plot, includes:
7878

docs/common/interactions.en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#### Add interacions
1+
#### Add interactions
22

33
Usage:
44

0 commit comments

Comments
 (0)