Skip to content

Commit b97dda1

Browse files
authored
Minor typographical or comment changes (#6025)
- Fix capitalization and pluralization of `Cells` - Add comment for `.get_selected_cells` - Add comment for `.get_selected_cells_indices` - Fix typo in `.ensure_focused` - Fix capitalization in `.render_cell_output` and `.clear_output` and `.clear_cells_outputs`
1 parent 57d063c commit b97dda1

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

notebook/static/notebook/js/notebook.js

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -601,7 +601,7 @@ define([
601601
};
602602

603603
/**
604-
* Get all Cell objects in this notebook.
604+
* Get all cell objects in this notebook.
605605
*
606606
* @return {Array} This notebook's Cell objects
607607
*/
@@ -614,7 +614,7 @@ define([
614614
};
615615

616616
/**
617-
* Get a Cell objects from this notebook.
617+
* Get a cell object from this notebook.
618618
*
619619
* @param {integer} index - An index of a cell to retrieve
620620
* @return {Cell} Cell or null if no cell was found.
@@ -721,13 +721,21 @@ define([
721721
return i;
722722
};
723723

724-
724+
/**
725+
* Get the selected cells.
726+
*
727+
* @return {Cell} The selected cells or null if no cell was found.
728+
*/
725729
Notebook.prototype.get_selected_cells = function () {
726730
return this.get_cells().filter(function(cell, index){ return cell.selected || soft_selected(cell) || cell.anchor;});
727731
};
728-
732+
733+
/**
734+
* Get the selected cells.
735+
*
736+
* @return {array} cell indicies
737+
*/
729738
Notebook.prototype.get_selected_cells_indices = function () {
730-
731739
var result = [];
732740
this.get_cells().filter(function (cell, index) {
733741
if (cell.selected || soft_selected(cell) || cell.anchor) {
@@ -737,7 +745,6 @@ define([
737745
return result;
738746
};
739747

740-
741748
/**
742749
* Get the currently selected cell.
743750
*
@@ -970,7 +977,7 @@ define([
970977
};
971978

972979
/**
973-
* Ensure either cell, or codemirror is focused. Is none
980+
* Ensure either cell or codemirror is focused. If none
974981
* is focused, focus the cell.
975982
*/
976983
Notebook.prototype.ensure_focused = function(){
@@ -1715,7 +1722,7 @@ define([
17151722
};
17161723

17171724
/**
1718-
* Re-render the output of a CodeCell.
1725+
* Re-render the output of a code cell.
17191726
*/
17201727
Notebook.prototype.render_cell_output = function (code_cell) {
17211728
var cell_data = code_cell.toJSON();
@@ -1998,7 +2005,7 @@ define([
19982005
};
19992006

20002007
/**
2001-
* Clear the selected CodeCell's output area.
2008+
* Clear a code cell's output area.
20022009
*
20032010
* @param {integer} index - cell index
20042011
*/
@@ -2012,7 +2019,7 @@ define([
20122019
};
20132020

20142021
/**
2015-
* Clear multiple selected CodeCells' output areas.
2022+
* Clear multiple selected code cells' output areas.
20162023
*
20172024
*/
20182025
Notebook.prototype.clear_cells_outputs = function(indices) {

0 commit comments

Comments
 (0)