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

AlC documentation update #29796

Merged
merged 2 commits into from
Oct 22, 2020
Merged

AlC documentation update #29796

merged 2 commits into from
Oct 22, 2020

Conversation

AnthonyLim23
Copy link
Contributor

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
  • 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?
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.

@AnthonyLim23 AnthonyLim23 added Patch Candidate Urgent issues that must be included in a patch following a release ISIS Team: Spectroscopy Issue and pull requests managed by the Spectroscopy subteam at ISIS labels Oct 22, 2020
@AnthonyLim23 AnthonyLim23 added this to the Release 5.1.1 milestone Oct 22, 2020
@AnthonyLim23 AnthonyLim23 changed the base branch from master to release-next October 22, 2020 12:29
@Matt-Cumber Matt-Cumber self-assigned this Oct 22, 2020
Copy link
Contributor

@Matt-Cumber Matt-Cumber left a 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?

@AnthonyLim23
Copy link
Contributor Author

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.

@Matt-Cumber
Copy link
Contributor

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 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.

I think the benefit of only saying one way to do things, is that it makes it simpler and less confusing for the user.

That's fair enough, if Steve is happy then this is fine

@AnthonyLim23
Copy link
Contributor Author

ah sorry, you will in the package build

Copy link
Contributor

@Matt-Cumber Matt-Cumber left a 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 👍

@martyngigg martyngigg merged commit 9072b92 into release-next Oct 22, 2020
@martyngigg martyngigg deleted the ALCDoc branch October 22, 2020 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ISIS Team: Spectroscopy Issue and pull requests managed by the Spectroscopy subteam at ISIS Patch Candidate Urgent issues that must be included in a patch following a release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants