##// END OF EJS Templates
improve js documentation
Matthias BUSSONNIER -
Show More
@@ -169,7 +169,7 b' var IPython = (function (IPython) {'
169 * typically when new outputs are added.
169 * typically when new outputs are added.
170 *
170 *
171 * Behavior is undefined if autoscroll is lower than scroll_threshold,
171 * Behavior is undefined if autoscroll is lower than scroll_threshold,
172 * unless it is < 0 then autoscroll will never be triggerd
172 * unless it is < 0, in which case autoscroll will never be triggered
173 *
173 *
174 * @property auto_scroll_threshold
174 * @property auto_scroll_threshold
175 * @type Number
175 * @type Number
@@ -180,8 +180,8 b' var IPython = (function (IPython) {'
180
180
181
181
182 /**
182 /**
183 * Defautl value for minimal length for output are to be able to switch to
183 * Lower limit (in lines) for OutputArea to be made scrollable. OutputAreas
184 * scroll mode
184 * shorter than this are never scrolled.
185 *
185 *
186 * @property scroll_threshold
186 * @property scroll_threshold
187 * @type Number
187 * @type Number
@@ -192,14 +192,17 b' var IPython = (function (IPython) {'
192
192
193
193
194 /**
194 /**
195 * Scroll OutputArea if height supperior than a threshold.
196 *
195 *
197 * Treshold is exprimed as a number of lines, fallback to a (configurable) default.
196 * Scroll OutputArea if height supperior than a threshold (in lines).
198 *
197 *
199 * Negative or null (0) threshold will prevent the OutputArea ever to scroll.
198 * Threshold is a maximum number of lines. If unspecified, defaults to
199 * OutputArea.scroll_threshold.
200 *
201 * Negative or null (0) threshold will prevent the OutputArea from ever
202 * scrolling
200 *
203 *
201 * @method scroll_if_long
204 * @method scroll_if_long
202 * @param [lines=20,configurable]{Number}
205 * @param [lines=OutputArea.scroll_threshold]{Number} Default to `OutputArea.scroll_threshold`
203 *
206 *
204 **/
207 **/
205 OutputArea.prototype.scroll_if_long = function (lines) {
208 OutputArea.prototype.scroll_if_long = function (lines) {
General Comments 0
You need to be logged in to leave comments. Login now