Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Harmonize the use of ellipses in command and menu items #16237

Merged
merged 16 commits into from Apr 26, 2024

Conversation

Rob-P-Smith
Copy link
Contributor

Audited all menu-bar options for required ellipses or removal of ellipses.

As mentioned in the commit, a few items required ellipses at certain times while not requiring them at other times. Those dual nature elements were not adjusted.

References

#16025

Code changes

/packages/notebook-extension/schema/export.json line 16 removed ellipses from label
/packages/notebook-extension/index.ts line 2420 added ellipses to label
/packages/apputils-extension/index.ts line 653 added ellipses to label

User-facing changes

Adjusted ellipses to conform with the guidance posted in the issue.
Added ellipses to Show Keyboard Shortcuts under help menu.
Added ellipses to Close and Shut Down Notebook under file menu.
Removed ellipses on Save and Export Notebook As under file menu.

Updated areas:
three
two
One

Backwards-incompatible changes

None

Rob-P-Smith and others added 7 commits April 23, 2024 18:21
Adjusted wording to satisfy issue jupyterlab#16321

Use "Folder", not "Directory", in file browser settings jupyterlab#16231
 File>Save and Export Notebook As

-Added elipses to:
 File>Close and Shut Down Notebook
 Help>Show Keyboard Shortcuts

 There remain some dual nature menu items that may or may not pop up a prompt depending on save history of current open files. I did not change these elipse situations Examples: File > Save and File > Close All Tabs

IAW standards mentioned in issue jupyterlab#16025
 File>Save and Export Notebook As

-Added elipses to:
 File>Close and Shut Down Notebook
 Help>Show Keyboard Shortcuts

 There remain some dual nature menu items that may or may not pop up a prompt depending on save history of current open files. I did not change these elipse situations Examples: File > Save and File > Close All Tabs

IAW standards mentioned in issue jupyterlab#16025
Copy link

Thanks for making a pull request to jupyterlab!
To try out this branch on binder, follow this link: Binder

@Rob-P-Smith
Copy link
Contributor Author

@meeseeksdev tag bug

@lumberbot-app lumberbot-app bot added the bug label Apr 24, 2024
@JasonWeill
Copy link
Contributor

Several of the test cases now fail, because the menus are different. You can comment with please update snapshots when you're ready to regenerate both galata and documentation screenshots.

Copy link
Contributor

Documentation snapshots updated.

Copy link
Contributor

@JasonWeill JasonWeill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Save Current Workspace…" should not have an ellipsis, because if the workspace already has a name, this command does not require user attention.

If the current workspace has not yet been saved, the command will call "Save Current Workspace As…", which has an ellipsis, and should keep it.

.gitignore Outdated
@@ -148,3 +148,4 @@ packages/lsp/src/_*
# generated reports
webpack-bundle-analyzer.html
examples/**/test-results/
docker/start.sh
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file isn't relevant to this change. Can you please remove this line from .gitignore, and remove the empty docker/start.sh file from your branch?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will attempt to do so, it was not intended to be in the commit.

@@ -650,7 +650,7 @@ const utilityCommands: JupyterFrontEndPlugin<void> = {
});

commands.addCommand(CommandIDs.displayShortcuts, {
label: trans.__('Show Keyboard Shortcuts'),
label: trans.__('Show Keyboard Shortcuts...'),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use the ellipsis character …, which looks very similar to three periods, but which is not the same.

  • Ellipsis:
  • Three periods: ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, i will redo the code changes to fix this.

Copy link
Contributor

Galata snapshots updated.

@Rob-P-Smith
Copy link
Contributor Author

Rob-P-Smith commented Apr 26, 2024

Thank you for your patience Jason, trying not to make life harder on others while I learn.

I think I've satisfied your feedback.

bot please update snapshots

Copy link
Contributor

Documentation snapshots updated.

Copy link
Contributor

Galata snapshots updated.

@krassowski krassowski changed the title Ellipses added/removed per issue #16025 Harmonize the use of ellipses in command and menu items Apr 26, 2024
@krassowski krassowski added this to the 4.2.0 milestone Apr 26, 2024
@krassowski krassowski linked an issue Apr 26, 2024 that may be closed by this pull request
@krassowski
Copy link
Member

The failure in:

    [jupyterlab] › test/jupyterlab/kernel.test.ts:27:9 › Kernel › Notebook › Should remember kernel auto start for notebook 

appears relevant, the test will need updating.

@@ -2417,7 +2417,7 @@ function addCommands(
isEnabled
});
commands.addCommand(CommandIDs.closeAndShutdown, {
label: trans.__('Close and Shut Down Notebook'),
label: trans.__('Close and Shut Down Notebook'),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is an ellipsis needed here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah because it shows a confirmation dialog.

Copy link
Member

@krassowski krassowski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@krassowski krassowski merged commit d84e8e0 into jupyterlab:main Apr 26, 2024
81 checks passed
@Rob-P-Smith Rob-P-Smith deleted the elipses branch April 26, 2024 22:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use ellipses consistently in menu items and commands
3 participants