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

Document the DXTBX rotation operator convention #1917

Merged
merged 3 commits into from
Nov 11, 2021
Merged

Conversation

benjaminhwilliams
Copy link
Member

DXTBX uses an in-house convention for the representation of the goniostat rotation operator R. Here, I've added documentation of that convention to the conventions.rst page of the docs.

Questions for reviewers:

  1. Is this the right place for this information? It is more developer documentation than user documentation, so it may want to live on some other page.
  2. Is the content correct?
  3. Does the content make sense? Is it intelligible?
  4. Could it be more concise?

Partial fix for cctbx/dxtbx#128.

@codecov
Copy link

codecov bot commented Nov 9, 2021

Codecov Report

Merging #1917 (65025a2) into main (5824297) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1917   +/-   ##
=======================================
  Coverage   67.11%   67.11%           
=======================================
  Files         619      619           
  Lines       70012    70012           
  Branches     9733     9733           
=======================================
  Hits        46992    46992           
  Misses      21053    21053           
  Partials     1967     1967           

@benjaminhwilliams
Copy link
Member Author

This has informal 👍 offline from @elena-pascal & @dagewa.

@benjaminhwilliams benjaminhwilliams merged commit 0609b93 into main Nov 11, 2021
@benjaminhwilliams benjaminhwilliams deleted the goniometer-doc branch November 11, 2021 12:04
dagewa pushed a commit to dagewa/dials that referenced this pull request Dec 13, 2021
DXTBX uses an in-house convention for the representation of the 
goniostat rotation operator R. Here, add documentation of that 
convention to the conventions.rst page of the docs.

Closes cctbx/dxtbx#128.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants