Adding toggle line numbers for all cells #1312

vivi · 2016-04-07T00:18:45Z

Hi! I'm a research apprentice at BIDS with Matthias (@ Carreau). This is for #1244.

Creates a button in the main toolbar that will toggle the line numbers on/off in all code cells. Future PR will have line numbering persist (i.e. new code cells will have line numbers turned on, if the user turned on line numbers for all cells).

…t Shift-L

ellisonbg · 2016-04-07T04:48:42Z

Great, thanks for the contribution. Could you post a screenshot showing the
design of the button in the toolbar to help in its review?

On Wed, Apr 6, 2016 at 5:18 PM, Vivian Fang [email protected]
wrote:

Hi! I'm a research apprentice at BIDS with Matthias (@ Carreau). This is
for #1244 #1244.

Creates a button in the main toolbar that will toggle the line numbers
on/off in all code cells. Future PR will have line numbering persist (i.e.
new code cells will have line numbers turned on, if the user turned on line

numbers for all cells).

You can view, comment on, or merge this pull request online at:

#1312
Commit Summary

adding an action for toggling all line numbers, with keyboard
shortcut Shift-L

File Changes

M notebook/static/notebook/js/actions.js
https://github.com/jupyter/notebook/pull/1312/files#diff-0 (8)

M notebook/static/notebook/js/keyboardmanager.js
https://github.com/jupyter/notebook/pull/1312/files#diff-1 (1)

M notebook/static/notebook/js/maintoolbar.js
https://github.com/jupyter/notebook/pull/1312/files#diff-2 (1)

M notebook/static/notebook/js/notebook.js
https://github.com/jupyter/notebook/pull/1312/files#diff-3 (12)

Patch Links:

https://github.com/jupyter/notebook/pull/1312.patch

https://github.com/jupyter/notebook/pull/1312.diff

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub
#1312

Brian E. Granger
Associate Professor of Physics and Data Science
Cal Poly State University, San Luis Obispo
@ellisonbg on Twitter and GitHub
[email protected] and [email protected]

minrk · 2016-04-07T17:25:33Z

Great! It seems to me like this should go in the View menu, rather than the toolbar, though, given its relatively rare frequency.

Carreau · 2016-04-07T19:15:41Z

Great, thanks for the contribution. Could you post a screenshot showing the
design of the button in the toolbar to help in its review?

Screenshot added on first comment.

Carreau · 2016-04-07T19:16:33Z

notebook/static/notebook/js/notebook.js

@@ -65,6 +65,7 @@ define(function (require) {
        this.ws_url = options.ws_url;
        this._session_starting = false;
        this.last_modified = null;
+        this.line_numbers = false;


I think I would make that private with a leading underscore, so that we can change the implementation easily.

Carreau · 2016-04-07T19:18:04Z

Do we want to make the "all lines" numbers a property so that you can easily implement not a only a toggle, but a "show all" and "hide all".

ellisonbg · 2016-04-07T20:50:13Z

I tend to agree with @minrk that this is used infrequently and should probably be in the View menu. At the same time it doesn't take up much space in the toolbar.

But, in either case, it should be included in the View menu (even if in the toolbar as well)

Carreau · 2016-04-07T21:01:05Z

I tend to agree with @minrk that this [...] should probably be in the View menu.

Sure, I was just showing @Secant how to do thing, we did not get to the point of adding it in the menu.

[...] this is used infrequently [...]

Well... it is used infrequently...

There is no UI to do it
it was practically speaking not possible to do it.

It's like arguing that setting you car is self driving mode is not such a useful feature an as a proof you show that the number of car that self-drive on the road is low.

Also, it also depend on whether we persist the value in nbconfig or not. If we persist it, people will use it once and forget it. At which point I agree that the toolbar is likely not necessary. If we don't persist it and keep it as an instance variable. some users will likely use it every time they open the notebook.

Lastly, It was one of the most requested feature at JupyterDays, which make me think that – in the case we don't persist it to nbconfig – a visible UI element for it seem likely useful.

takluyver · 2016-04-07T21:18:28Z

I think that in the long run, a menu entry and persistence is the right way to do this. Whether we want to put it in the menu first and trust that we get round to persistence, or put it in the toolbar until we do persistence, I'm not sure.

Carreau · 2016-04-07T23:07:25Z

BTW, just for @Secant information, the View menu is generated server side in notebook/templates/notebook.html

So you likely want to create a new menu like that

diff --git a/notebook/templates/notebook.html b/notebook/templates/notebook.html
index 10e6095..d9f5329 100644
--- a/notebook/templates/notebook.html
+++ b/notebook/templates/notebook.html
@@ -162,6 +162,10 @@ data-notebook-path="{{notebook_path | urlencode}}"
                             <a href="#">Cell Toolbar</a>
                             <ul class="dropdown-menu" id="menu-cell-toolbar-submenu"></ul>
                         </li>
+                        <li class="divider"></li>
+                        <li id="jupyter-notebook-toggle-line-number-or-any-other-id-you-like">
+                            <a href="#">Toggle Line Number</a>
+                        </li>
                     </ul>
                 </li>

and you probably figured out on yourself that you have to modify id_actions_dict in menubar.js to bind the menu with the action id.

Hope that helps.

Feel free to push any more commit on the same branch and the PR will update.
You can also ask question, I think anyone in this thread will be happy to help you.

ellisonbg · 2016-04-08T05:09:16Z

I like the idea of adding it to the View menu and making it persistent.
Then users can start to use it and we can see if it is userd enough to be
on the toolbar.

On Thu, Apr 7, 2016 at 4:07 PM, Matthias Bussonnier <
[email protected]> wrote:

BTW, just for @Secant https://github.com/secant information, the View
menu is generated server side in notebook/templates/notebook.html
https://github.com/jupyter/notebook/blob/master/notebook/templates/notebook.html

So you likely want to create a new menu like that

diff --git a/notebook/templates/notebook.html b/notebook/templates/notebook.html
index 10e6095..d9f5329 100644
--- a/notebook/templates/notebook.html
+++ b/notebook/templates/notebook.html
@@ -162,6 +162,10 @@ data-notebook-path="{{notebook_path | urlencode}}"
Cell Toolbar
                   <li class="divider"></li>
                   <li id="jupyter-notebook-toggle-line-number-or-any-other-id-you-like">
                       <a href="#">Toggle Line Number</a>
                   </li>
             </ul>
         </li>
and you probably figured out on yourself that you have to modify
id_actions_dict in menubar.js to bind the menu with the action id.

Hope that helps.

Feel free to push any more commit on the same branch and the PR will
update.
You can also ask question, I think anyone in this thread will be happy to
help you.

—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#1312 (comment)

Brian E. Granger
Associate Professor of Physics and Data Science
Cal Poly State University, San Luis Obispo
@ellisonbg on Twitter and GitHub
[email protected] and [email protected]

SylvainCorlay · 2016-04-10T17:37:03Z

👍

gnestor · 2016-08-11T02:15:25Z

Reviving this one... I moved the toggle line numbers from the toolbar to the "View" menu. See #1676.

@ellisonbg Any UX feedback?

adding an action for toggling all line numbers, with keyboard shortcu…

21bbe1d

…t Shift-L

Carreau reviewed Apr 7, 2016
View reviewed changes

willingc mentioned this pull request Apr 8, 2016

Line Numbers are not saved jupyter/jupyter#9

Closed

minrk added this to the 5.0 milestone Apr 8, 2016

Carreau self-assigned this Jun 4, 2016

Carreau modified the milestones: 4.3, 5.0 Jul 29, 2016

This was referenced Aug 11, 2016

[WIP] Toggle all line numbers, & persist config #1423

Closed

View > Toggle line numbers #1676

Merged

ellisonbg merged commit 21bbe1d into jupyter:master Aug 16, 2016

PrasadBabarendaGamage mentioned this pull request Jul 11, 2020

Showing line numbers for code blocks spatialaudio/nbsphinx#478

Open

github-actions bot added the status:resolved-locked label Apr 12, 2021

github-actions bot locked as resolved and limited conversation to collaborators Apr 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding toggle line numbers for all cells #1312

Adding toggle line numbers for all cells #1312

vivi commented Apr 7, 2016

ellisonbg commented Apr 7, 2016

numbers for all cells).

minrk commented Apr 7, 2016

Carreau commented Apr 7, 2016

Carreau Apr 7, 2016

Carreau commented Apr 7, 2016

ellisonbg commented Apr 7, 2016

Carreau commented Apr 7, 2016

takluyver commented Apr 7, 2016

Carreau commented Apr 7, 2016

ellisonbg commented Apr 8, 2016

SylvainCorlay commented Apr 10, 2016

gnestor commented Aug 11, 2016 •

edited

Loading

Adding toggle line numbers for all cells #1312

Adding toggle line numbers for all cells #1312

Conversation

vivi commented Apr 7, 2016

ellisonbg commented Apr 7, 2016

numbers for all cells).

minrk commented Apr 7, 2016

Carreau commented Apr 7, 2016

Carreau Apr 7, 2016

Choose a reason for hiding this comment

Carreau commented Apr 7, 2016

ellisonbg commented Apr 7, 2016

Carreau commented Apr 7, 2016

takluyver commented Apr 7, 2016

Carreau commented Apr 7, 2016

ellisonbg commented Apr 8, 2016

SylvainCorlay commented Apr 10, 2016

gnestor commented Aug 11, 2016 • edited Loading

gnestor commented Aug 11, 2016 •

edited

Loading