Skip to content

Commit 93fe6d9

Browse files
committed
typo fixs
1 parent f66256b commit 93fe6d9

File tree

2 files changed

+34
-30
lines changed

2 files changed

+34
-30
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,19 @@ I also created the porting of the [Numworks' Kandinsky module](https://github.co
3131

3232
#### battery():
3333
* Parameters: **No parameters**
34-
* Description: Return battery voltage
34+
* Description: Return battery voltage *(give a fake result)*
3535

3636
#### battery_level():
3737
* Parameters: **No parameters**
38-
* Description: Return battery level
38+
* Description: Return battery level *(give a fake result)*
3939

4040
#### battery_ischarging():
4141
* Parameters: **No parameters**
42-
* Description: Return True if the battery is charging
42+
* Description: Return True if the battery is charging *(give a fake result)*
4343

4444
#### set_brightness():
4545
* Parameters: ``level``
46-
* Description: Set brightness level of screen
46+
* Description: Set brightness level of screen *(do nothing)*
4747

4848
#### get_brightness():
4949
* Parameters: **No parameters**
@@ -103,17 +103,19 @@ I also created the porting of the [Numworks' Kandinsky module](https://github.co
103103

104104
### Environ variables
105105
> [!IMPORTANT]
106-
> You must make these additions before importing ion module, otherwise the changes will not take effect.
106+
> You must make these additions before importing the ion module, otherwise the changes will not take effect.
107107
108-
Some options can be modified by environ variables.<br>
109-
To do this, first add a compatibility check:
108+
Some library options can be modified by environ variables.<br>
109+
To do so, add a compatibility check and place the environ variables into:
110110
```python
111111
try:
112112
import os
113113
"<environ variables here>"
114114
except: pass
115115
```
116116

117+
<br>
118+
117119
* Change starting OS (methods according to the selected os will be created): <br>
118120
*(Option name is same as Kandinsky so that, if both libraries are present, they are synchronized)*
119121
```python
@@ -131,26 +133,26 @@ os.environ['ION_OS_MODE'] = '<number>'
131133

132134
* Enable debug mode:
133135
```python
134-
# Print full error stacktrace, the original pressed key and methods calls
136+
# Print full error stacktrace, the pressed key and methods calls
135137
os.environ['ION_ENABLE_DEBUG'] = ''
136138
```
137139

138140
* Disable warnings:
139141
```python
140-
# Will be disable all ion warnings
142+
# Will disable all ion warnings, like not found windows or incompatibilities.
141143
os.environ['ION_DISABLE_WARNINGS'] = ''
142144
```
143145

144-
* Disable reading inputs only in kandinsky window (if kandinsky is not imported globally, this option is enabled by default):
146+
* Disable inputs reading only from the kandinsky window:
145147
```python
146-
# This options allow to read keyboard inputs in python console and kandinsky window
147-
# By default it just read kandinsky window (only if is focused)
148-
# Note: if is not imported globally, this option is enabled by default
148+
# This options allow keyboard inputs reading from the python console and the kandinsky window
149+
# By default it only reads the kandinsky window (only if focused by user)
150+
# Note: if kandinsky is not imported globally, this option is enabled by default
149151
os.environ['ION_DISABLE_KANDINSKY_INPUT_ONLY'] = ''
150152
```
151153

152-
* Get keyboard inputs everywhere (not only in kandinsky window or python console):
154+
* Get keyboard inputs everywhere (not only from kandinsky window or python console):
153155
```python
154-
# Allow to get inputs in entire system, like previous version of library
156+
# Allow to get inputs from entire system, like previous version of library
155157
os.environ['ION_ENABLE_GET_INPUT_EVERYWHERE'] = ''
156158
```

src/ion/README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,19 @@ I also created the porting of the [Numworks' Kandinsky module](https://github.co
3131

3232
#### battery():
3333
* Parameters: **No parameters**
34-
* Description: Return battery voltage
34+
* Description: Return battery voltage *(give a fake result)*
3535

3636
#### battery_level():
3737
* Parameters: **No parameters**
38-
* Description: Return battery level
38+
* Description: Return battery level *(give a fake result)*
3939

4040
#### battery_ischarging():
4141
* Parameters: **No parameters**
42-
* Description: Return True if the battery is charging
42+
* Description: Return True if the battery is charging *(give a fake result)*
4343

4444
#### set_brightness():
4545
* Parameters: ``level``
46-
* Description: Set brightness level of screen
46+
* Description: Set brightness level of screen *(do nothing)*
4747

4848
#### get_brightness():
4949
* Parameters: **No parameters**
@@ -103,17 +103,19 @@ I also created the porting of the [Numworks' Kandinsky module](https://github.co
103103

104104
### Environ variables
105105
> [!IMPORTANT]
106-
> You must make these additions before importing ion module, otherwise the changes will not take effect.
106+
> You must make these additions before importing the ion module, otherwise the changes will not take effect.
107107
108-
Some options can be modified by environ variables.<br>
109-
To do this, first add a compatibility check:
108+
Some library options can be modified by environ variables.<br>
109+
To do so, add a compatibility check and place the environ variables into:
110110
```python
111111
try:
112112
import os
113113
"<environ variables here>"
114114
except: pass
115115
```
116116

117+
<br>
118+
117119
* Change starting OS (methods according to the selected os will be created): <br>
118120
*(Option name is same as Kandinsky so that, if both libraries are present, they are synchronized)*
119121
```python
@@ -131,26 +133,26 @@ os.environ['ION_OS_MODE'] = '<number>'
131133

132134
* Enable debug mode:
133135
```python
134-
# Print full error stacktrace, the original pressed key and methods calls
136+
# Print full error stacktrace, the pressed key and methods calls
135137
os.environ['ION_ENABLE_DEBUG'] = ''
136138
```
137139

138140
* Disable warnings:
139141
```python
140-
# Will be disable all ion warnings
142+
# Will disable all ion warnings, like not found windows or incompatibilities.
141143
os.environ['ION_DISABLE_WARNINGS'] = ''
142144
```
143145

144-
* Disable reading inputs only in kandinsky window (if kandinsky is not imported globally, this option is enabled by default):
146+
* Disable inputs reading only from the kandinsky window:
145147
```python
146-
# This options allow to read keyboard inputs in python console and kandinsky window
147-
# By default it just read kandinsky window (only if is focused)
148-
# Note: if is not imported globally, this option is enabled by default
148+
# This options allow keyboard inputs reading from the python console and the kandinsky window
149+
# By default it only reads the kandinsky window (only if focused by user)
150+
# Note: if kandinsky is not imported globally, this option is enabled by default
149151
os.environ['ION_DISABLE_KANDINSKY_INPUT_ONLY'] = ''
150152
```
151153

152-
* Get keyboard inputs everywhere (not only in kandinsky window or python console):
154+
* Get keyboard inputs everywhere (not only from kandinsky window or python console):
153155
```python
154-
# Allow to get inputs in entire system, like previous version of library
156+
# Allow to get inputs from entire system, like previous version of library
155157
os.environ['ION_ENABLE_GET_INPUT_EVERYWHERE'] = ''
156158
```

0 commit comments

Comments
 (0)