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

update documentation for deprecated matplotlib references #38141

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

yusufjimoh
Copy link
Contributor

@yusufjimoh yusufjimoh commented Oct 3, 2024

Description of work

Summary of work

update deprecated matplotlib references in mantid documentation to the latest

Fixes #37603.

To test:

Build the docs-html target and check that the changes render correctly

This does not require release notes because it is only a documentation update.


Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

@yusufjimoh yusufjimoh marked this pull request as ready for review October 4, 2024 07:26
@yusufjimoh yusufjimoh added Documentation Issues and pull requests related to documentation Maintenance Unassigned issues to be addressed in the next maintenance period. ISIS Team: Core Issue and pull requests managed by the Core subteam at ISIS labels Oct 4, 2024
@yusufjimoh yusufjimoh added this to the Release 6.12 milestone Oct 4, 2024
@rbauststfc rbauststfc self-assigned this Oct 4, 2024
Copy link
Contributor

@rbauststfc rbauststfc left a comment

Choose a reason for hiding this comment

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

Looks like a really thorough update of all the relevant URLs. I've built both the user and dev docs and the changes are rendering well with all the new links working.

I noticed a very small typo that is unrelated to these changes but might be good to fix while we're here, if that's OK.

The other thing that might just be good to discuss quickly with the Core team (if you haven't already) is that I think at the moment we're on Matplotlib 3.7. Despina is working on #38077 to move us to 3.8. The current stable version is 3.9. I've noticed that a lot of the URL updates in this PR are pointing us to the docs for the stable version. The benefit of not specifying the version in the links is obviously that they won't need updating every time we update Matplotlib, but there is a small risk that we're pointing to documentation that isn't totally accurate for the version we're on. Might be good to just get a second opinion from Core to confirm we're happy with this.

@@ -959,4 +959,4 @@ A list of some common properties you might want to change and the keywords to se
+--------------------+-------------------------+------------+

A much fuller list of properties is avialble `in the Matplotlib documentation
Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry, this isn't part of your changes, but while we're here could we fix the typo in the spelling of the word "available" here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues and pull requests related to documentation ISIS Team: Core Issue and pull requests managed by the Core subteam at ISIS Maintenance Unassigned issues to be addressed in the next maintenance period.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation references Deprecated URL for 3D Plotting in Matplotlib
2 participants