Skip to content

Commit 2792d6a

Browse files
author
Cheap Nightbot
authored
Fix Typos in docs & docstrings (#48)
Sincere Apologies ~(>_<。)\
1 parent abceb7a commit 2792d6a

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

docs/tutorial1_basicusage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ plugin_info = {
1616
}
1717
```
1818

19-
Use ``async`` prefix to define a `main` function. Creat `vts` instance in `main`.
19+
Use ``async`` prefix to define a `main` function. Create `vts` instance in `main`.
2020

2121
```python
2222
async def main():
23-
myvts = pyvts.vts(plugin_info=plugin_info)
24-
await myvts.connect()
23+
vts = pyvts.vts(plugin_info=plugin_info)
24+
await vts.connect()
2525
```
2626

2727
Continue with `main` function, to get access of more features, we need to get authenticated from `Vtube Studio API`.

docs/tutorial2_triggerhotkey.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ First import packages
66
import asyncio, pyvts
77
```
88

9-
Then specify the plugin information and creat `vts` instance in `main`.
9+
Then specify the plugin information and create `vts` instance in `main`.
1010

1111
```python
1212
plugin_info = {
@@ -32,7 +32,7 @@ Contd. with ``main()``, request list of hotkey from VtubeStudio
3232
print(hotkey_list) # ['My Animation 1', 'My Animation 2', ...]
3333
```
3434

35-
Contd. with ``main``, send request to triiger hotkey
35+
Contd. with ``main``, send request to trigger hotkey
3636

3737
```python
3838
send_hotkey_request = myvts.vts_request.requestTriggerHotKey(hotkey_list[0])

examples/start.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ async def main():
3838
print(new_paraemter_value["data"]) # show
3939

4040
# Delete that parameter
41-
await asyncio.sleep(3) # sleep 10 seconds
41+
await asyncio.sleep(3) # sleep for 3 seconds
4242
return_msg = await vts.request(
4343
vts.vts_request.requestDeleteCustomParameter(new_parameter_name)
4444
) # delete the parameter

pyvts/vts.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class vts:
1919
Information about your plugin.
2020
2121
vts_api_info: dict of {"version", "name", "port"}
22-
Informatiopn about VtubeStudio API.
22+
Information about VTubeStudio API.
2323
2424
**kwarg :
2525
In case you just want to change serveral of the plugin/api Args,

0 commit comments

Comments
 (0)