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

Clarification of geometry and material documents #24431

Merged
merged 1 commit into from Jan 10, 2019
Merged

Conversation

peterfpeterson
Copy link
Member

@peterfpeterson peterfpeterson commented Jan 7, 2019

This split out the material information into a new concept page, added additional links between the various docs, and added a big note at the top of SetSample that the dict definitions are in cm.

To test:

Build the docs and decide that they are better than they were.

Fixes #21467


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

@peterfpeterson peterfpeterson added the Documentation Issues and pull requests related to documentation label Jan 7, 2019
@peterfpeterson peterfpeterson added this to the Release 3.14 (4.0?) milestone Jan 7, 2019
This split out the material information into a new concept page, added
additional links between the various docs, and added a big note at the
top of `SetSample` that the dict definitions are in cm.
@peterfpeterson
Copy link
Member Author

I added the (Li7) example to the docs. I didn't know that was an issue, but it definitely benefits from the clarification.

Copy link
Member

@martyngigg martyngigg left a comment

Choose a reason for hiding this comment

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

I'm happy with the new structure - it gives more clarity for the concepts and algorithms that should be used.

@SimonHeybrock SimonHeybrock merged commit 8e2afad into master Jan 10, 2019
@SimonHeybrock SimonHeybrock deleted the geometry_docs branch January 10, 2019 06:23
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants