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

Enhancement of "Center of Rotation and Tilt" Documentation #2424

Merged
merged 2 commits into from
Dec 9, 2024

Conversation

ashleymeigh2
Copy link
Collaborator

@ashleymeigh2 ashleymeigh2 commented Dec 3, 2024

Issue

Closes #2414

Description

  • Updated the "Center of Rotation and Tilt" documentation to include a more detailed explanation of COR and Tilt concepts, their importance, and how they are calculated.
  • Expanded sections on Why COR Matters and Why Tilt Matters to provide clear use cases and context.
  • Improved the Manual COR Correction instructions for usability.

Testing

  • Confirmed reStructuredText (rst) formatting compliance by rendering the document locally and ensuring proper formatting in the output.
  • Reviewed for consistency with the style of other documentation in the repository.

Acceptance Criteria

  • Open the rendered documentation file and ensure all sections are well-structured and properly formatted.
  • Verify that the descriptions and explanations are clear, particularly:
  • The updated definitions of COR and Tilt.

Copy link
Collaborator

@samtygier-stfc samtygier-stfc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the clean-ups

@samtygier-stfc samtygier-stfc added this pull request to the merge queue Dec 9, 2024
Merged via the queue into main with commit 5216e1c Dec 9, 2024
2 checks passed
@samtygier-stfc samtygier-stfc deleted the 2414_COR_and_tilt_docs branch December 9, 2024 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve COR and Tilt Documentation
3 participants