-
Notifications
You must be signed in to change notification settings - Fork 123
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
AlC documentation update #29796
AlC documentation update #29796
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great and is a nice snippet as to what is going on behind the scenes with the ALC. Is it worth mentioning you can also change the instrument through file -> settings, and reach manage user directories through file -> manage user directories. Also not sure if this is just me but the help button (little question mark) on the ALC doesn't take me to the ALC docs and instead I get Missing page - qthelp://org.mantidproject/doc/interfaces/Muon ALC.html
. Looks like an s is missing from docs maybe?
You need to build the docs explicitly. It is easier to just use the docs-html target and then find the file in the build directory. I think the benefit of only saying one way to do things, is that it makes it simpler and less confusing for the user. |
I have built the docs and all links work etc. But I thought you should be able to still see the help page from this button.
That's fair enough, if Steve is happy then this is fine |
ah sorry, you will in the package build |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes look good to me 👍
Description of work.
This updates the ALC docs. I have agreed the wording with Steve.
-->
To test:
Build the docs, check it looks ok and that the link works.
Reviewer
Please comment on the following (full description):
Code Review
Functional Tests
Does everything look good? Mark the review as Approve. A member of
@mantidproject/gatekeepers
will take care of it.