Skip to content

Commit f033eaa

Browse files
Fix some small things on readme
1 parent f86d911 commit f033eaa

File tree

1 file changed

+7
-16
lines changed

1 file changed

+7
-16
lines changed

README.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ a:
5959
{}
6060
```
6161

62-
Even better, it can track then changes of the object after the changes of the variable
62+
Even better, it can track the changes of the object after the changes of the variable
6363

6464
```python
6565
from watchpoints import watch
@@ -135,7 +135,7 @@ d["a"]:
135135
1
136136
```
137137

138-
watchpoints will try to guess what you want to monitor, and monitor it as you expect(well most of the time)
138+
**watchpoints will try to guess what you want to monitor, and monitor it as you expect**(well most of the time)
139139

140140
### unwatch
141141

@@ -157,7 +157,7 @@ Or you can unwatch everything by passing no argument to it
157157
unwatch() # unwatch everything
158158
```
159159

160-
monitoring variables will introduce a significant overhead, and should be used for debugging only.
160+
**monitoring variables will introduce a significant overhead, and should be used for debugging only.**
161161

162162
### alias
163163

@@ -170,18 +170,9 @@ watch(a, alias="james")
170170
unwatch("james")
171171
```
172172

173-
### customize print
174-
175-
By default, watchpoints uses ```pprint``` for data printing, and print for strings. You can use your own printer function to print in any format you like
176-
177-
```python
178-
watch(a, printer=my_print)
179-
```
180-
181-
182173
### customize callback
183174

184-
Of course sometimes you want to print in your own format, or even something more than print. You can use your own callback for monitored variables
175+
Of course sometimes you want to print in your own format, or even do something more than print. You can use your own callback for monitored variables
185176

186177
```python
187178
watch(a, callback=my_callback)
@@ -193,9 +184,9 @@ The callback function takes three arguments
193184
def my_callback(frame, elem, exec_info)
194185
```
195186

196-
```frame``` is the current frame when a change is detected.
197-
```elem``` is a ```WatchElement``` object that I'm to lazy to describe for now.
198-
```exec_info``` is a tuple of ```(funcname, filename, lineno)``` of the line that changed the variable
187+
* ```frame``` is the current frame when a change is detected.
188+
* ```elem``` is a ```WatchElement``` object that I'm to lazy to describe for now.
189+
* ```exec_info``` is a tuple of ```(funcname, filename, lineno)``` of the line that changed the variable
199190

200191
You can also set change the callback function globally by
201192

0 commit comments

Comments
 (0)