[doc] various points
- Introduction ("about", cf #450 (closed))
-
Early on, say which operating systems are currently supported. -
What is OpenHKL: "a real space 3D model" - our 3D space is 2D pixel coordinate of unrolled detector, plus crystal rotation. To me, this is not "real space". - Also in the tutorial, "Finding peaks". -
Easily extensible ...: "a .yaml machine file" might be confusing, especially for readers who do not know YAML; "machine" might be related to the data format, not the diffractometer. -
Written in C++: "user friendly for the end user" - one user too much.
-
- Installation:
-
Foresee alternatives for different OSs, even if some of them are not yet supported. -
Install dependencies: For the most important distributions / package managers, provide list of the actual package names, which the user can just paste to the command line. -
Before make install
, I would expectmake test
.
-
- Tutorial:
-
Section headings change voice: from Loading, Finding, Indexing to Predict, Integrate, Merge. -
Reduce size of screenshots so that their font is not larger than the font of the running text. Smaller images will be less disruptive for linear reading. -
Any reason why the left and right masks in the "Masking the detector images" figure do not extend over the full height of the detector? -
"The table in the Home widget now shows that the data is loaded" - without magnification, the screenshot shows me nothing. -
Finding peaks: "instead of on" ? -
"some peaks are marked as invalid; specifically" - I would expect the number of invalid, not of valid peaks to follow -
In the Autoindexing section, "P212121, which corresponds body-centred orthorhombic Bravais lattice": rather than fixing the typo with "corresponds to a", I'd suggest "implies a", since this an n:1, not a 1:1 correspondence. -
After the "Shape model parameters", language switches from "we" to "I" -
Images of predicted peaks before and after applying shape model: Can we get more contrasting colors than light green on blueish? Also in the actual software? -
"may be indicative of" -> "may indicate"?
-
- Peaktable:
-
"reason forrejection" in table rendered with missing blank
-
- Generic:
-
Convert to American spelling.
-
Edited by Wuttke, Joachim