Update CZIcmd usage documentation for clarity#160
Conversation
Reformatted the `CZIcmd` usage instructions to improve readability and consistency. Updated the `code-block` directive from `bash` to `console` for better context. Enhanced alignment, spacing, and formatting of command descriptions and examples. Ensured the help text matches the updated format. No functional changes were made; updates are limited to documentation and presentation.
There was a problem hiding this comment.
Pull request overview
This PR fixes reStructuredText formatting issues in the CZIcmd usage documentation. The primary change addresses malformed code-block directive syntax by adding proper indentation and a blank line separator, which was causing rendering problems on the documentation website. The directive type was also updated from bash to console for better semantic accuracy.
Key changes:
- Fixed
.. code-block::directive formatting with proper blank line and indentation - Changed code-block type from
bashtoconsole - Reformatted all command-line help text with consistent 4-space indentation
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #160 +/- ##
=======================================
Coverage 66.38% 66.38%
=======================================
Files 96 96
Lines 12365 12365
=======================================
Hits 8209 8209
Misses 4156 4156
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
m-aXimilian
left a comment
There was a problem hiding this comment.
The two remaining Copilot suggestions seem legitimate to me.
Other than that LGTM.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Refactor the help text for the --rect/-r option in code and documentation for better readability and clarity, especially regarding relative and absolute coordinates. Update czicmd_usage.rst to libCZI version 0.67.3 and reformat several option descriptions for consistency and improved user experience. No functional changes to program behavior.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Description
Reformatted the
CZIcmdusage instructions to improve readability and consistency. Updated thecode-blockdirective frombashtoconsolefor better context. Enhanced alignment, spacing, and formatting of command descriptions and examples. Ensured the help text matches the updated format. No functional changes were made; updates are limited to documentation and presentation.The distorted page is this.
The issue is that in reStructuredText, the content of a .. code-block:: directive must be:
Type of change
How Has This Been Tested?
no code changes
Checklist: