Skip to content

Commit ce615a2

Browse files
authored
docs: Fix a few typos (#3525)
There are small typos in: - CONTRIBUTING.md - site/docs/api/plot-api.en.md - site/docs/api/plots/funnel.en.md - site/docs/api/plots/violin.en.md Fixes: - Should read `violins` rather than `voilins`. - Should read `transmitted` rather than `transimitted`. - Should read `element` rather than `elemnet`. - Should read `details` rather than `detials`. - Should read `congratulations` rather than `congradulations`. Signed-off-by: Tim Gates <[email protected]>
1 parent 556b54c commit ce615a2

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ $ 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 written in the following format.
27+
# If your modification pass the tests, congratulations 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
@@ -104,7 +104,7 @@ BREAKING CHANGE:
104104
Breaks foo.bar api, foo.baz should be used instead
105105
```
106106

107-
Look at [these files](https:// docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit) for more detials.
107+
Look at [these files](https:// docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit) for more details.
108108

109109
## Release
110110

site/docs/api/plot-api.en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Destroy the entire canvas completely, recycle all resources, and keep only the D
7777
plot.on(event: string, callback: Function);
7878
```
7979
80-
Keep listening to a plot event and trigger a callback function. The event mechanism is transimitted transparently through G2 events. See [G2 event mechanism](https://g2.antv.vision/zh/docs/api/general/event) for all event lists and callback function parameters.
80+
Keep listening to a plot event and trigger a callback function. The event mechanism is transmitted transparently through G2 events. See [G2 event mechanism](https://g2.antv.vision/zh/docs/api/general/event) for all event lists and callback function parameters.
8181
8282
### 8. once
8383

site/docs/api/plots/funnel.en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Whether the plot is transposed.
5454

5555
<description>**optional** _boolean_ _default:_ `false`</description>
5656

57-
Whether the height is dynamic. When set to `true`, the height of each elemnet in funnel plot is directly proportional to the corresponding value of yField.
57+
Whether the height is dynamic. When set to `true`, the height of each element in funnel plot is directly proportional to the corresponding value of yField.
5858

5959
#### maxSize
6060

site/docs/api/plots/violin.en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ type BoxOption = {
8080
8181
<description>**optional** _'smooth'|'hollow'|'hollow-smooth'_</description>
8282
83-
The shape of violin geometry. Could be 'smooth', 'hollow' or 'hollow-smooth'. Defaults to rough, solid voilins.
83+
The shape of violin geometry. Could be 'smooth', 'hollow' or 'hollow-smooth'. Defaults to rough, solid violins.
8484
8585
#### violinStyle
8686

0 commit comments

Comments
 (0)