chore(docs): document wedge and edge difference #214
Conversation
jeertmans
force-pushed
the
document-wedge-vs-edge
branch
from
743ecf9 to
ab56e29
Compare
|
Hi @jeertmans , Could you please either amend a commit and add a sign-off or add the sign-off to the pull request as a comment? We need that to ensure that proper authorship is documented. |
fix typo Signed-off-by: Jérome Eertmans <jeertmans@icloud.com>
Signed-off-by: Faycal Ait Aoudia <faitaoudia@nvidia.com>
jeertmans
force-pushed
the
document-wedge-vs-edge
branch
from
017b36c to
5b2b631
Compare
|
Hi @faycalaa, like this? My commits were already signed (I think) with a GPG key, but I added "Signed-off-by: ..." in my commit message. |
|
Hi @jeertmans, yes, this is all good, thank you! Thanks a lot for your continuous contributions to the project. |
|
Ok thanks for the clarification @gmarcusm ! I hope I will be able to perform more technical contributions in the future ;-) |
Seems like my PR NVlabs#214 introduced a problem where the heading level is not correct, which renders wrongly when docs are compiled. Signed-off-by: Jérome Eertmans <jeertmans@icloud.com>
Seems like my PR NVlabs#214 introduced a problem where the heading level is not correct, which renders wrongly when docs are compiled. Signed-off-by: Jérome Eertmans <jeertmans@icloud.com> fix(docs): link rendering
Seems like my PR #214 introduced a problem where the heading level is not correct, which renders wrongly when docs are compiled. Signed-off-by: Jérome Eertmans <jeertmans@icloud.com> fix(docs): link rendering
Description
This PR improves the current RT documentation by explaining the difference between wedge and edge.
The difference between edges and wedges is not always clear in the RT community, and I think writing some words in the Diffraction Tutorial would make sense. I also hesitated to put some words about that in the relevant Python docstrings, i.e., the methods with an
edge_diffractionparameter.Please tell me if I need to rephrase something, or else.
Checklist
[ ] Added references to issues and discussions[ ] Added / modified documentation as needed[ ] Added / modified unit tests as needed[ ] Passes all tests[] Lint the code[ ] Co-authored with someone? Add Co-authored-by: user@domain and ensure they signed off their commits too.