Documentation for 7 algorithms including usage examples #666
Conversation
This file contains 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
Signed-off-by: Karl Palmen <karl.palmen@stfc.ac.uk>
Signed-off-by: Karl Palmen <karl.palmen@stfc.ac.uk>
Signed-off-by: Karl Palmen <karl.palmen@stfc.ac.uk>
Signed-off-by: Karl Palmen <karl.palmen@stfc.ac.uk>
KarlPalmen
added
High Priority
|
@KarlPalmen It looks like there is a crash in the unit tests for |
Signed-off-by: Karl Palmen <karl.palmen@stfc.ac.uk>
| @@ -25,4 +25,29 @@ from an integer will have its (h,k,l) set to (0,0,0). The calculated | |||
| Miller indices can either be rounded to the nearest integer value, or | |||
| can be left as decimal fractions. | |||
|
|
|||
| Usage | |||
| ----- | |||
|
|
|||
There was a problem hiding this comment.
Shouldn't this also include:: ../usagedata-note.txt
|
I'm putting the usage data note in now. |
Signed-off-by: Karl Palmen <karl.palmen@stfc.ac.uk>
stuartcampbell
added a commit
that referenced
this pull request
May 1, 2015
Documentation for 7 algorithms including usage examples
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request is about ticket #9726 which has 7 remaining algorithms, which needed usage examples and one (Stepscan) , which required a flowchart.
To test verify that the documentation has been improved and usage examples work. If any requires further work done that cannot be done quickly, please put it into a new ticket.