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

Nest grids. Produce PDF manual. #9

Closed
wants to merge 1 commit into from

Conversation

blakeNaccarato
Copy link
Owner

Description

Motivation and context

Test plan

Checklist

  • My code follows this project's code style.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • My change is adequately tested.

Terms

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @blakeNaccarato - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

@@ -6,7 +6,15 @@ For more detail, see the manual in the black binder in {numref}`00-01-ref`, the

First, turn on the instrument by pressing the power button indicated in {numref}`00-04-turn-on`, and the laptop associated with this instrument in {numref}`00-18-laptop`. Note that the language bar in {numref}`00-05-language` may need to be set to "English (United States)" if it is not set already. Open the software by clicking on the icon indicated in {numref}`00-06-desktop-software-indicated`, and you will be prompted with the login dialog in {numref}`00-07-login`. Just click "OK" to proceed. The instrument should be left to warm up for about thirty minutes before testing.

::::{grid} 1 1 2 2
:::::::{grid} 12
Copy link

Choose a reason for hiding this comment

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

suggestion (code_refinement): Consider simplifying the grid layout for better readability and maintenance.

Using a simpler grid structure might make the document easier to maintain and modify in the future, especially if the layout or content changes.

Suggested change
:::::::{grid} 12
:::::::{grid} 1

@@ -152,6 +192,14 @@ You don't need to select a "Material Lot" for the Pyrex reference sample.

Proceed to [](#checking-on-a-test-run) to monitor the test for the first few measurements, after which you can leave it unattended.

::::::::{grid} 12
Copy link

Choose a reason for hiding this comment

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

suggestion (code_refinement): Assess if the additional complexity of the grid layout is justified by the content requirements.

The added complexity of the grid layout should be justified by specific content presentation requirements. If not, a simpler layout might be more effective.

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.

1 participant