upstream/ipython Commit - r19509:4f104102

Some clean-up

Jonathan Frederic -

r19509:4f104102

parent child

IPython/html/static/notebook/js/notebook.js

0 +72 -64

                  /**
                   * Contains and manages cells.
                   * @class Notebook
-                  * @param {String} selector
+                  * @param {string} selector
                   * @param {dictionary} options - Dictionary of keyword arguments.
                   *                     events: $(Events) instance
                   *                     keyboard_manager: KeyboardManager instance
                  };
                  /**
-                  * trigger a warning dialog about missing functionality from newer minor versions
+                  * Trigger a warning dialog about missing functionality from newer minor versions
                   */
                  Notebook.prototype.warn_nbformat_minor = function (event) {
                      var v = 'v' + this.nbformat + '.';
                  /**
                   * Scroll the top of the page to a given cell.
                   *
-                  * @param {Number} cell_number An index of the cell to view
-                  * @param {Number} time Animation time in milliseconds
-                  * @return {Number} Pixel offset from the top of the container
+                  * @param {number} cell_number An index of the cell to view
+                  * @param {number} time Animation time in milliseconds
+                  * @return {number} Pixel offset from the top of the container
                   */
                  Notebook.prototype.scroll_to_cell = function (cell_number, time) {
                      var cells = this.get_cells();
                  // Edit Notebook metadata
+                 /**
+                  * Display a dialog that allows the user to edit the Notebook's metadata.
+                  * @return {null}
+                  */
                  Notebook.prototype.edit_metadata = function () {
                      var that = this;
                      dialog.edit_metadata({
                  /**
                   * Get a particular cell element.
                   *
-                  * @param {Number} index An index of a cell to select
+                  * @param {number} index An index of a cell to select
                   * @return {jQuery} A selector of the given cell.
                   */
                  Notebook.prototype.get_cell_element = function (index) {
                  /**
                   * Try to get a particular cell by msg_id.
                   *
-                  * @param {String} msg_id A message UUID
+                  * @param {string} msg_id A message UUID
                   * @return {Cell} Cell or null if no cell was found.
                   */
                  Notebook.prototype.get_msg_cell = function (msg_id) {
                  /**
                   * Count the cells in this notebook.
                   *
-                  * @return {Number} The number of cells in this notebook
+                  * @return {number} The number of cells in this notebook
                   */
                  Notebook.prototype.ncells = function () {
                      return this.get_cell_elements().length;
                  /**
                   * Get a Cell object from this notebook.
                   *
-                  * @param {Number} index An index of a cell to retrieve
+                  * @param {number} index An index of a cell to retrieve
                   * @return {Cell} Cell or null if no cell was found.
                   */
                  Notebook.prototype.get_cell = function (index) {
                   * Get the numeric index of a given cell.
                   *
                   * @param {Cell} cell The provided cell
-                  * @return {Number} The cell's numeric index or null if no cell was found.
+                  * @return {number} The cell's numeric index or null if no cell was found.
                   */
                  Notebook.prototype.find_cell_index = function (cell) {
                      var result = null;
                  /**
                   * Get a given index , or the selected index if none is provided.
                   *
-                  * @param {Number} index A cell's index
-                  * @return {Number} The given index, or selected index if none is provided.
+                  * @param {number} index A cell's index
+                  * @return {number} The given index, or selected index if none is provided.
                   */
                  Notebook.prototype.index_or_selected = function (index) {
                      var i;
                  /**
                   * Check whether a cell index is valid.
                   *
-                  * @param {Number} index A cell index
+                  * @param {number} index A cell index
                   * @return True if the index is valid, false otherwise
                   */
                  Notebook.prototype.is_valid_cell_index = function (index) {
                  /**
                   * Get the index of the currently selected cell.
-                  * @return {Number} The selected cell's numeric index
+                  * @return {number} The selected cell's numeric index
                   */
                  Notebook.prototype.get_selected_index = function () {
                      var result = null;
                  /**
                   * Programmatically select a cell.
                   *
-                  * @param {Number} index A cell's index
+                  * @param {number} index A cell's index
                   * @return {Notebook} This notebook
                   */
                  Notebook.prototype.select = function (index) {
                  /**
                   * Gets the index of the cell that is in edit mode.
                   *
-                  * @return index {int}
+                  * @return index {integer}
                   **/
                  Notebook.prototype.get_edit_index = function () {
                      var result = null;
                  /**
                   * Handle when a a cell blurs and the notebook should enter command mode.
                   *
-                  * @param [cell] {Cell} Cell to enter command mode on.
+                  * @param {Cell} [cell] Cell to enter command mode on.
                   **/
                  Notebook.prototype.handle_command_mode = function (cell) {
                      if (this.mode !== 'command') {
                  /**
                   * Handle when a cell fires it's edit_mode event.
                   *
-                  * @param [cell] {Cell} Cell to enter edit mode on.
+                  * @param {Cell} [cell] Cell to enter edit mode on.
                   **/
                  Notebook.prototype.handle_edit_mode = function (cell) {
                      if (cell && this.mode !== 'edit') {
                  /**
                   * Move given (or selected) cell up and select it.
                   *
-                  * @param [index] {integer} cell index
+                  * @param {integer} [index] cell index
                   * @return {Notebook} This notebook
                   **/
                  Notebook.prototype.move_cell_up = function (index) {
                  /**
                   * Move given (or selected) cell down and select it
                   *
-                  * @param [index] {integer} cell index
+                  * @param {integer} [index] cell index
                   * @return {Notebook} This notebook
                   **/
                  Notebook.prototype.move_cell_down = function (index) {
                  /**
                   * Delete a cell from the notebook.
                   *
-                  * @param [index] A cell's numeric index
+                  * @param {integer} [index] cell's numeric index
                   * @return {Notebook} This notebook
                   */
                  Notebook.prototype.delete_cell = function (index) {
                   *
                   * Index will be brought back into the accessible range [0,n]
                   *
-                  * @param [type] {string} in ['code','markdown', 'raw'], defaults to 'code'
-                  * @param [index] {int} a valid index where to insert cell
+                  * @param {string} [type] in ['code','markdown', 'raw'], defaults to 'code'
+                  * @param {integer} [index] a valid index where to insert cell
                   *
-                  * @return cell {cell|null} created cell or null
+                  * @return {Cell|null} created cell or null
                   **/
                  Notebook.prototype.insert_cell_at_index = function(type, index){
                   * Insert an element at given cell index.
                   * return true if everything whent fine.
                   *
-                  * @param element {dom_element} a cell element
-                  * @param [index] {int} a valid index where to inser cell
                   * @private
+                  * @param {HTMLElement} element - a cell element
+                  * @param {integer} [index] a valid index where to inser cell
                   **/
                  Notebook.prototype._insert_element_at_index = function(element, index){
                      if (element === undefined){
                   *
                   * default index value is the one of currently selected cell
                   *
-                  * @param [type] {string} cell type
-                  * @param [index] {integer}
+                  * @param {string} [type] cell type
+                  * @param {integer} [index]
                   *
-                  * @return handle to created cell or null
+                  * @return {Cell|null} handle to created cell or null
                   **/
                  Notebook.prototype.insert_cell_above = function (type, index) {
                      index = this.index_or_selected(index);
                   *
                   * default index value is the one of currently selected cell
                   *
-                  * @param [type] {string} cell type
-                  * @param [index] {integer}
+                  * @param {string} [type] cell type
+                  * @param {integer} [index]
                   *
-                  * @return handle to created cell or null
+                  * @return {Cell|null} handle to created cell or null
                   **/
                  Notebook.prototype.insert_cell_below = function (type, index) {
                      index = this.index_or_selected(index);
                  /**
                   * Insert cell at end of notebook
                   *
-                  * @param {String} type cell type
+                  * @param {string} type cell type
                   *
-                  * @return the added cell; or null
+                  * @return {Cell|null} the added cell; or null
                   **/
                  Notebook.prototype.insert_cell_at_bottom = function (type){
                      var len = this.ncells();
                  /**
                   * Turn a cell into a code cell.
                   *
-                  * @param {Number} [index] A cell's index
+                  * @param {number} [index] A cell's index
                   */
                  Notebook.prototype.to_code = function (index) {
                      var i = this.index_or_selected(index);
                  /**
                   * Turn a cell into a Markdown cell.
                   *
-                  * @param {Number} [index] A cell's index
+                  * @param {number} [index] A cell's index
                   */
                  Notebook.prototype.to_markdown = function (index) {
                      var i = this.index_or_selected(index);
                  /**
                   * Turn a cell into a raw text cell.
                   *
-                  * @param {Number} [index] A cell's index
+                  * @param {number} [index] A cell's index
                   */
                  Notebook.prototype.to_raw = function (index) {
                      var i = this.index_or_selected(index);
                      }
                  };
-                 Notebook.prototype._warn_heading = function () {
-                     /**
-                      * warn about heading cells being removed
-                      * @private
-                      */
+                 Notebook.prototype._warn_heading = function () {
                      dialog.modal({
                          notebook: this,
                          keyboard_manager: this.keyboard_manager,
                      });
                  };
-                 Notebook.prototype.to_heading = function (index, level) {
                  /**
                   * Turn a cell into a markdown cell with a heading.
                   *
-                  * @param {Number} [index] A cell's index
-                  * @param {Number} [level] A heading level (e.g., 1 for h1)
+                  * @param {number} [index] A cell's index
+                  * @param {number} [level] A heading level (e.g., 1 for h1)
                   */
+                 Notebook.prototype.to_heading = function (index, level) {
                      this.to_markdown(index);
                      level = level || 1;
                      var i = this.index_or_selected(index);
                  /**
                   * Hide a cell's output.
                   *
-                  * @param {Number} index A cell's numeric index
+                  * @param {integer} index - A cell's numeric index
                   */
                  Notebook.prototype.collapse_output = function (index) {
                      var i = this.index_or_selected(index);
                  /**
                   * Show a cell's output.
                   *
-                  * @param {Number} index A cell's numeric index
+                  * @param {integer} index - A cell's numeric index
                   */
                  Notebook.prototype.expand_output = function (index) {
                      var i = this.index_or_selected(index);
                  /**
                   * Clear the selected CodeCell's output area.
                   *
-                  * @param {Number} index A cell's numeric index
+                  * @param {integer} index - A cell's numeric index
                   */
                  Notebook.prototype.clear_output = function (index) {
                      var i = this.index_or_selected(index);
                  /**
                   * Scroll the selected CodeCell's output area.
                   *
-                  * @param {Number} index A cell's numeric index
+                  * @param {integer} index - A cell's numeric index
                   */
                  Notebook.prototype.scroll_output = function (index) {
                      var i = this.index_or_selected(index);
                  /** Toggle whether a cell's output is collapsed or expanded.
                   *
-                  * @param {Number} index A cell's numeric index
+                  * @param {integer} index - A cell's numeric index
                   */
                  Notebook.prototype.toggle_output = function (index) {
                      var i = this.index_or_selected(index);
                  /**
                   * Toggle a scrollbar for long cell outputs.
                   *
-                  * @param {Number} index A cell's numeric index
+                  * @param {integer} index - A cell's numeric index
                   */
                  Notebook.prototype.toggle_output_scroll = function (index) {
                      var i = this.index_or_selected(index);
                  /**
                   * Execute a contiguous range of cells.
                   *
-                  * @param {Number} start Index of the first cell to execute (inclusive)
-                  * @param {Number} end Index of the last cell to execute (exclusive)
+                  * @param {integer} start - Index of the first cell to execute (inclusive)
+                  * @param {integer} end - Index of the last cell to execute (exclusive)
                   */
                  Notebook.prototype.execute_cell_range = function (start, end) {
                      this.command_mode();
                  /**
                   * Getter method for this notebook's name.
                   *
-                  * @return {String} This notebook's name (excluding file extension)
+                  * @return {string} This notebook's name (excluding file extension)
                   */
                  Notebook.prototype.get_notebook_name = function () {
                      var nbname = this.notebook_name.substring(0,this.notebook_name.length-6);
                  /**
                   * Setter method for this notebook's name.
                   *
-                  * @param {String} name A new name for this notebook
+                  * @param {string} name A new name for this notebook
                   */
                  Notebook.prototype.set_notebook_name = function (name) {
                      var parent = utils.url_path_split(this.notebook_path)[0];
                  /**
                   * Check that a notebook's name is valid.
                   *
-                  * @param {String} nbname A name for this notebook
-                  * @return {Boolean} True if the name is valid, false if invalid
+                  * @param {string} nbname - A name for this notebook
+                  * @return {boolean} True if the name is valid, false if invalid
                   */
                  Notebook.prototype.test_notebook_name = function (nbname) {
                      nbname = nbname || '';
                  /**
                   * Load a notebook from JSON (.ipynb).
                   *
-                  * @param {Object} data JSON representation of a notebook
+                  * @param {Object} data - JSON representation of a notebook
                   */
                  Notebook.prototype.fromJSON = function (data) {
                  /**
                   * Start an autosave timer, for periodically saving the notebook.
                   *
-                  * @param {Integer} interval the autosave interval in milliseconds
+                  * @param {integer} interval - the autosave interval in milliseconds
                   */
                  Notebook.prototype.set_autosave_interval = function (interval) {
                      var that = this;
                  /**
                   * Success callback for saving a notebook.
                   *
-                  * @param {Integer} start Time when the save request start
-                  * @param {Object} data JSON representation of a notebook
+                  * @param {integer} start - Time when the save request start
+                  * @param {Object} data - JSON representation of a notebook
                   */
                  Notebook.prototype.save_notebook_success = function (start, data) {
                      this.set_dirty(false);
                  /**
                   * update the autosave interval based on how long the last save took
                   *
-                  * @param {Integer} timestamp when the save request started
+                  * @param {integer} timestamp - when the save request started
                   * @private
                   */
                  Notebook.prototype._update_autosave_interval = function (start) {
                  /**
                   * Explicitly trust the output of this notebook.
+                  *
                   */
                  Notebook.prototype.trust_notebook = function () {
                      var body = $("<div>").append($("<p>")
                  /**
                   * Request a notebook's data from the server.
                   *
-                  * @param {String} notebook_path A notebook to load
+                  * @param {string} notebook_path - A notebook to load
                   */
                  Notebook.prototype.load_notebook = function (notebook_path) {
                      this.notebook_path = notebook_path;
                  /**
                   * Success callback for listing checkpoints.
                   *
-                  * @param {Object} data JSON representation of a checkpoint
+                  * @param {Object} data - JSON representation of a checkpoint
                   */
                  Notebook.prototype.list_checkpoints_success = function (data) {
                      this.checkpoints = data;
                  /**
                   * Success callback for creating a checkpoint.
                   *
-                  * @param {Object} data JSON representation of a checkpoint
+                  * @param {Object} data - JSON representation of a checkpoint
                   */
                  Notebook.prototype.create_checkpoint_success = function (data) {
                      this.add_checkpoint(data);
                      this.events.trigger('checkpoint_created.Notebook', data);
                  };
+                 /**
+                  * Display the restore checkpoint dialog
+                  * @param  {string} checkpoint ID
+                  * @return {null}
+                  */
                  Notebook.prototype.restore_checkpoint_dialog = function (checkpoint) {
                      var that = this;
                      checkpoint = checkpoint || this.last_checkpoint;
                  /**
                   * Restore the notebook to a checkpoint state.
                   *
-                  * @param {String} checkpoint ID
+                  * @param {string} checkpoint ID
                   */
                  Notebook.prototype.restore_checkpoint = function (checkpoint) {
                      this.events.trigger('notebook_restoring.Notebook', checkpoint);
                  /**
                   * Delete a notebook checkpoint.
                   *
-                  * @param {String} checkpoint ID
+                  * @param {string} checkpoint ID
                   */
                  Notebook.prototype.delete_checkpoint = function (checkpoint) {
                      this.events.trigger('notebook_restoring.Notebook', checkpoint);

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	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