Skip to content

Commit 51a2033

Browse files
committed
Fix documentation build and prettify docs.
1 parent c97078d commit 51a2033

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

shared-bindings/supervisor/__init__.c

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -113,33 +113,33 @@ MP_DEFINE_CONST_FUN_OBJ_1(supervisor_set_next_stack_limit_obj, supervisor_set_ne
113113
//| def set_next_code_file(filename: Optional[str], /, *, reload_on_success : bool = False, reload_on_error: bool = False, sticky_on_success: bool = False, sticky_on_error: bool = False, sticky_on_reload: bool = False) -> None:
114114
//| """Set what file to run on the next vm run.
115115
//|
116-
//| When not None, the given filename is inserted at the front of the usual ['code.py',
116+
//| When not ``None``, the given ``filename`` is inserted at the front of the usual ['code.py',
117117
//| 'main.py'] search sequence.
118118
//|
119119
//| The optional keyword arguments specify what happens after the specified file has run:
120120
//|
121-
//| sticky_on_… determine whether the newly set filename and options stay in effect: If True,
122-
//| further runs will continue to run that file (unless it says otherwise by calling
123-
//| set_next_code_filename() itself). If False, the settings will only affect one run and revert
124-
//| to the standard code.py/main.py afterwards.
121+
//| ``sticky_on_…`` determine whether the newly set filename and options stay in effect: If
122+
//| True, further runs will continue to run that file (unless it says otherwise by calling
123+
//| ``set_next_code_filename()`` itself). If False, the settings will only affect one run and
124+
//| revert to the standard code.py/main.py afterwards.
125125
//|
126-
//| reload_on_… determine how to continue: If False, wait in the usual "Code done running.
126+
//| ``reload_on_…`` determine how to continue: If False, wait in the usual "Code done running.
127127
//| Waiting for reload. / Press any key to enter the REPL. Use CTRL-D to reload." state. If
128128
//| True, reload immediately as if CTRL-D was pressed.
129129
//|
130-
//| …_on_success take effect when the program runs to completion or calls sys.exit().
130+
//| ``…_on_success`` take effect when the program runs to completion or calls ``sys.exit()``.
131131
//|
132-
//| …_on_error take effect when the program exits with an exception, including the
132+
//| ``…_on_error`` take effect when the program exits with an exception, including the
133133
//| KeyboardInterrupt caused by CTRL-C.
134134
//|
135-
//| …_on_reload take effect when the program is interrupted by files being written to the USB
136-
//| drive (auto-reload) or when it calls supervisor.reload().
135+
//| ``…_on_reload`` take effect when the program is interrupted by files being written to the USB
136+
//| drive (auto-reload) or when it calls ``supervisor.reload()``.
137137
//|
138138
//| These settings are stored in RAM, not in persistent memory, and will therefore only affect
139139
//| soft reloads. Powering off or resetting the device will always revert to standard settings.
140140
//|
141141
//| When called multiple times in the same run, only the last call takes effect, replacing any
142-
//| settings made by previous ones. This is the main use of passing None as a filename: to
142+
//| settings made by previous ones. This is the main use of passing ``None`` as a filename: to
143143
//| reset to the standard search sequence."""
144144
//| ...
145145
//|

0 commit comments

Comments
 (0)