Fix doc polyhedrons#735
Conversation
upload figure tetrahedron.png for model tetrahedron.py
updated file name for the figure
update tetrahedron.png (size 318 k)
change to a=400 A in the plot figure caption
updated plot figure t=0 and t=0.5 for radius_a=400 Angs
update of the figures
upload of new figure with file called tetra_truncation.png
deleted extra figure
deleted old version figure
small version
small version
smaller version
old version deleted
last version with correct name
| DOI: https://doi.org/10.1107/s160057672201130x | ||
| "Form factor of any polyhedron and its singularities derived from a projection method". | ||
| In: Journal of Applied Crystallography, 56(1), 167–177. | ||
| https://doi.org/10.1107/s160057672201130x |
There was a problem hiding this comment.
Common citation styles (e.g., MLA, APA, Chicago, Elsevier, Harvard, Vancouver) do not use "In: " for journal articles. Many put the journal name in *in italics*.
We don't have a fixed style though I lean toward APA
There was a problem hiding this comment.
Thank you, I put all the citations in APA style in the last commit, it should be good now (ddeab37).
| radius_a = radius_b = radius_c, \quad t = \frac{1}{2} | ||
|
|
||
| The model contains 4 parameters: :math:`radius_a`, the two ratios :math:`b2a_ratio` and :math:`c2a_ratio` and :math:`t`: | ||
| The model contains 4 parameters: :math:`radius_a`, the two ratios :math:`b2a_{\mathrm{ratio}}` and :math:`c2a_{\mathrm{ratio}}` and :math:`t`: |
There was a problem hiding this comment.
I usually use italics for model parameters, such as b2a_ratio rather than math markup. As math markup it would be b/a. Similarly radius_a with math markup
The symbols you choose in the math should match those in your diagrams.
Somewhere in the text you need to indicate how parameter names correspond to symbols.
There was a problem hiding this comment.
I tried to make clearer the correspondance between parameters names and math symbols at the begining of the documentation of each models in the last 2 commits (ddeab37 and bf668a5).
In the second commit, I focused on truncated_octahedron: I removed some redunduncy and I removed the b2a_ratio and c2a_ratio inside the mathematical formulas and put b/a instead.
3 participants
Fixes #733
Minor changes in the documentation of truncated_octahedron.py, truncated_tetrahedron.py, tetrahedron.py: formulas, plot legends, images, etc.