Skip to content

Fixed the help documentation launch link when the plot is a superplot #41083

Merged
SilkeSchomann merged 3 commits intomantidproject:mainfrom
RabiyaF:38044-help-button-link-update
Mar 20, 2026
Merged

Fixed the help documentation launch link when the plot is a superplot #41083
SilkeSchomann merged 3 commits intomantidproject:mainfrom
RabiyaF:38044-help-button-link-update

Conversation

@RabiyaF
Copy link
Member

@RabiyaF RabiyaF commented Mar 18, 2026

Description of work

Closes #38044 .

To test:

  1. Create a workspace ws = CreateSampleWorkspace()
  2. Open a Superplot
Screenshot 2026-03-18 at 4 33 34 pm
  1. Click Help
image
  1. Verify that the help page that opens is the documentation for Superplot.
image
  1. Unclick Superplot
image
  1. Click Help
image
  1. Verify that the help page that opens is the documentation for Basic 1D and Tiled Plots.
image

Reviewer

Your comments will be used as part of the gatekeeper process. Comment clearly on what you have checked and tested during your review. Provide an audit trail for any changes requested.

As per the review guidelines:

  • Is the code of an acceptable quality? (Code standards/GUI standards)
  • Has a thorough functional test been performed? Do the changes handle unexpected input/situations?
  • Are appropriately scoped unit and/or system tests provided?
  • Do the release notes conform to the guidelines and describe the changes appropriately?
  • Has the relevant (user and developer) documentation been added/updated?
  • If the PR author isn’t in the mantid-developers or mantid-contributors teams, add a review comment rerun ci to authorize/rerun the CI

Gatekeeper

As per the gatekeeping guidelines:

  • Has a thorough first line review been conducted, including functional testing?
  • At a high-level, is the code quality sufficient?
  • Are the base, milestone and labels correct?

@RabiyaF RabiyaF added this to the Release 6.16 milestone Mar 18, 2026
@RabiyaF RabiyaF force-pushed the 38044-help-button-link-update branch from 95ebe43 to 0181262 Compare March 18, 2026 16:43
@RabiyaF RabiyaF marked this pull request as ready for review March 19, 2026 10:42
@jclarkeSTFC jclarkeSTFC self-assigned this Mar 19, 2026
@jclarkeSTFC jclarkeSTFC requested a review from Copilot March 19, 2026 11:51
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Fixes Workbench plot Help button routing so that when the Superplot mode is active the Help action opens the Superplot documentation (per #38044), otherwise it continues to open the standard plotting help.

Changes:

  • Add FigureType.Superplot and map it to the workbench/superplot.html documentation page.
  • Route the Help button action to a Superplot-specific handler when the Superplot toggle is checked.
  • Add a release note entry describing the corrected documentation link.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
qt/python/mantidqt/mantidqt/plotting/figuretype.py Adds a FigureType enum entry for Superplot.
qt/applications/workbench/workbench/plotting/toolbar.py Emits a different signal from Help when Superplot is toggled on.
qt/applications/workbench/workbench/plotting/plothelppages.py Adds Superplot help URL and a superplot flag to select it.
qt/applications/workbench/workbench/plotting/figuremanager.py Connects the new toolbar signal to a Superplot help launcher.
docs/source/release/v6.16.0/Workbench/Bugfixes/38044.rst Release note for the Superplot help link fix.

You can also share your feedback on Copilot code review. Take the survey.

Copy link
Contributor

@jclarkeSTFC jclarkeSTFC left a comment

Choose a reason for hiding this comment

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

It's works well, but I think the comments from Copilot are worth addressing

@RabiyaF RabiyaF force-pushed the 38044-help-button-link-update branch from fb84403 to 8867b2d Compare March 19, 2026 13:34
@RabiyaF RabiyaF requested a review from jclarkeSTFC March 19, 2026 15:24
Copy link
Contributor

@jclarkeSTFC jclarkeSTFC left a comment

Choose a reason for hiding this comment

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

Thanks for making those changes

@SilkeSchomann SilkeSchomann self-assigned this Mar 20, 2026
@SilkeSchomann SilkeSchomann merged commit e1c7366 into mantidproject:main Mar 20, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Help button for superplot links to incorrect help page

4 participants