Skip to content

Commit 1cee219

Browse files
committed
Complete guide.md
1 parent 5639f59 commit 1cee219

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

docs/guide.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ Referred only in `tests.__init__` as `os.environ["__BUGZILLA_UNITTEST"] = "1"`.
191191

192192
## 2.4 Exit *MI*
193193

194-
It is recommand that do `CTRL`+`C` or equivalent operation. The try-except mechanism in `MI` would catch `KeyboardInterrupt` and print
194+
It is recommand that do <kbd>Ctrl</kbd>+<kbd>C</kbd> or equivalent operation. The try-except mechanism in `MI` would catch `KeyboardInterrupt` and print
195195
```text
196196
|v>STRING<v|
197197
Exited at user request
@@ -218,3 +218,18 @@ rather than
218218
If you do not specify explicitly, it may cause unpredictable exceptions to be raised or unexpected operations to be performed, although an automatic probe is supported.
219219

220220
## 3.2. Force creation of new connection instance
221+
222+
When you are at
223+
```text
224+
|v>ARGINF<v|
225+
ArgumentParser waiting
226+
|^>ARGINF<^|
227+
228+
```
229+
there is a special instruction
230+
```text
231+
__REFRESH__
232+
```
233+
When you write it to `stdin` and then write a *line break* (or press *Enter*) to launch, the internal instance of `bugzilla.Bugzilla` will be forced to be created in the next round, instead of try reading from cache first. (See also: `bugzilla._mi._make_bz_instance`)
234+
235+
This may be useful in some special situations, such as force discarding previously corrupted stuff or a bad socket.

0 commit comments

Comments
 (0)