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

Notebook 7.0.0 ignores kernel's help_links property #6963

Closed
Tracked by #7087
culler opened this issue Jul 9, 2023 · 9 comments · Fixed by #6968
Closed
Tracked by #7087

Notebook 7.0.0 ignores kernel's help_links property #6963

culler opened this issue Jul 9, 2023 · 9 comments · Fixed by #6968

Comments

@culler
Copy link

culler commented Jul 9, 2023

Problem

With Classic Jupyter and Jupyter Lab, when a kernel is selected to be used by a notebook, the kernel's help_links property is read and the contents are used to add kernel-specific items to the Help Menu. This useful feature appears to have been removed from Notebook 7.0.0. Testing with the SageMath kernel, which provides help_links as a property, indicates that the help_links getter is never called when a SageMath notebook is launched.

Proposed Solution

Please consider restoring this feature (or documenting it, if it actually exists in some other form.)

Additional context

@culler culler added enhancement status:Needs Triage Applied to issues that need triage labels Jul 9, 2023
@RRosio RRosio added bug regression and removed enhancement status:Needs Triage Applied to issues that need triage labels Jul 11, 2023
@RRosio
Copy link
Collaborator

RRosio commented Jul 11, 2023

Hi @culler thank you for submitting this issue! Do you see this in JupyterLab 4?

@culler
Copy link
Author

culler commented Jul 11, 2023

Thanks for responding @RRosio. No, I do not see this problem with jupyterlab-4.0.2 installed from pypi. It takes a few seconds, but the Help menu gets populated with all of the links provided by the SageMath kernel.

I am not at all sure this is relevant, but in the index.tsx file for the Jupyter Lab help-extension I see the following code. The part after the comment "// Generate a cache of the kernel help links", does not seem to have an analog in the notebook source tree:

    // Populate the Help menu.
    const helpMenu = mainMenu.helpMenu;

    const resourcesGroup = resources.map(args => ({
      args,
      command: CommandIDs.open
    }));
    helpMenu.addGroup(resourcesGroup, 10);

    // Generate a cache of the kernel help links.
    const kernelInfoCache = new Map<
      string,
      KernelMessage.IInfoReplyMsg['content']
    >(); 

@jtpio
Copy link
Member

jtpio commented Jul 17, 2023

Thanks @culler for reporting and trying Notebook 7.

Maybe it would just be a matter to include the @jupyterlab/help-extension:resources plugin in Notebook 7 to get these menu entries.

@jtpio jtpio added this to the 7.0 milestone Jul 17, 2023
@culler
Copy link
Author

culler commented Jul 17, 2023

Maybe so. I don't know.

But, if so, I would hope that the extension could be enabled by default, or by the kernel, or by somehow configuring the notebook package in advance before distributing it with the SageMath application. It seems less than optimal to expect a new user to know that getting help when using the SageMath kernel requires running a separate enable command for such an extension.

@jtpio
Copy link
Member

jtpio commented Jul 17, 2023

For reference I opened #6968 which should help fix this issue.

But we'll likely need jupyterlab/jupyterlab#14837 to be merged and released first in JupyterLab.

@culler
Copy link
Author

culler commented Jul 17, 2023

Thank you!!!!

@jtpio jtpio modified the milestones: 7.0, 7.0.x Jul 19, 2023
@culler
Copy link
Author

culler commented Sep 10, 2023

I was wondering if this could be finished up now. It looks like the jupyterlab dependency has been released.

@jtpio
Copy link
Member

jtpio commented Sep 11, 2023

Good point, thanks @culler for the ping 👍

@jtpio
Copy link
Member

jtpio commented Sep 11, 2023

Actually we still need to wait for this repo to update to the JupyterLab 4.1 packages first.

@jtpio jtpio modified the milestones: 7.0.x, 7.1 Oct 3, 2023
This was referenced Oct 3, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants