##// END OF EJS Templates
Add docstring to Session.restart
Jessica B. Hamrick -
Show More
@@ -198,6 +198,20 b' define(['
198 });
198 });
199 };
199 };
200
200
201 /**
202 * Restart the session by deleting it and the starting it
203 * fresh. If options are given, they can include any of the
204 * following:
205 *
206 * - notebook_name - the name of the notebook
207 * - notebook_path - the path to the notebook
208 * - kernel_name - the name (type) of the kernel
209 *
210 * @function restart
211 * @param {Object} [options] - options for the new kernel
212 * @param {function} [success] - function executed on ajax success
213 * @param {function} [error] - functon executed on ajax error
214 */
201 Session.prototype.restart = function (options, success, error) {
215 Session.prototype.restart = function (options, success, error) {
202 var that = this;
216 var that = this;
203 var start = function () {
217 var start = function () {
General Comments 0
You need to be logged in to leave comments. Login now