upstream/ipython Files · docs/jsdoc_plugin.js

run_cell returns an ExecutionResult instance...

run_cell returns an ExecutionResult instance gh-7256 asked for a boolean return value from run_cell() for whether code ran successfully. I discussed this with Min, who suggested that given the complexity of run_cell, it should return a result object that can store different pieces of information about what happened. This currently stores `execution_count`, `error_before_exec` (i.e. errors transforming, parsing or compiling the code), `error_in_exec` and `result`. It calculates `success` as a boolean that's true if neither of the error fields are set. Closes gh-7256

Jonathan Frederic - - Load All Authors

File last commit:

r19510:2bb1f2b3


                r19630:0e76a046

Download file

             jsdoc_plugin.js
        
                    11 lines
            
             | 448 B
            
                | application/javascript
            
             |
                JavascriptLexer
            
             / docs / jsdoc_plugin.js
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      exports.handlers = {

          newDoclet: function(e) {

              // e.doclet will refer to the newly created doclet

              // you can read and modify properties of that doclet if you wish

              if (typeof e.doclet.name === 'string') {

                  if (e.doclet.name[0] == '_') {

                      console.log('Private method "' + e.doclet.longname + '" not documented.');

                      e.doclet.memberof = '<anonymous>';

                  }

              }

          }

      };

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				exports.handlers = {
				newDoclet: function(e) {
				// e.doclet will refer to the newly created doclet
				// you can read and modify properties of that doclet if you wish
				if (typeof e.doclet.name === 'string') {
				if (e.doclet.name[0] == '_') {
				console.log('Private method "' + e.doclet.longname + '" not documented.');
				e.doclet.memberof = '<anonymous>';
				}
				}
				}
				};