Open
Conversation
Contributor
Unit test results2 861 tests 2 861 ✅ 2h 3m 5s ⏱️ Results for commit 783d5bb. |
Contributor
System test results808 tests 792 ✅ 2h 4m 41s ⏱️ Results for commit 783d5bb. |
| @@ -1,3 +1,6 @@ | |||
| .. _algm-BroadcastWorkspace: | |||
Member
There was a problem hiding this comment.
I haven't seen these references at the top of any other algorithms. I don't think they belong
| @@ -1,3 +1,4 @@ | |||
| .. _MatrixWorkspace: | |||
Member
There was a problem hiding this comment.
real question: would it be more clear to update what refers to the reference rather than adding one to the API page?
Contributor
Author
There was a problem hiding this comment.
i'm not sure i understand this question
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of work
Another part of work on updating documentation.
Many concept pages contain info that would be better served being part of their respective API pages.
This PR is a first pass migrating content from concept pages that have a clear 1-to-1 match api page.
As part of this, we may want to configure some redirects so that links to the old concept page get forwarded to the API page instead.
To test:
Build user docs, check that the listed pages are no longer listed in concepts index, inspect modified API pages and see the new content above the existing reference.
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:
mantid-developersormantid-contributorsteams, add a review commentrerun cito authorize/rerun the CIGatekeeper
As per the gatekeeping guidelines: