Skip to content

Update CZIcmd usage documentation for clarity#160

Merged
ptahmose merged 3 commits intoZEISS:mainfrom
ptahmose:jbl/fix_czicmd_documentation
Dec 10, 2025
Merged

Update CZIcmd usage documentation for clarity#160
ptahmose merged 3 commits intoZEISS:mainfrom
ptahmose:jbl/fix_czicmd_documentation

Conversation

@ptahmose
Copy link
Copy Markdown
Contributor

@ptahmose ptahmose commented Dec 5, 2025

Description

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.

The distorted page is this.
The issue is that in reStructuredText, the content of a .. code-block:: directive must be:

  1. Separated from the directive by a blank line
  2. Indented relative to the directive - which was not the case

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

no code changes

Checklist:

  • I followed the Contributing Guidelines.
  • I did a self-review.
  • I commented my code, particularly in hard-to-understand areas.
  • I updated the documentation.
  • I updated the version of libCZI following Versioning of libCZI depending on the type of change
    • Bug fix -> PATCH
    • New feature -> MINOR
    • Breaking change -> MAJOR
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.

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.
@ptahmose ptahmose requested review from a team and Copilot December 5, 2025 22:25
@ptahmose ptahmose added the cla Contributor License Agreement sent to Admin label Dec 5, 2025
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 bash to console
  • 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.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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
Copy link
Copy Markdown

codecov bot commented Dec 5, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 66.38%. Comparing base (da3d7dc) to head (f857e57).
⚠️ Report is 1 commits behind head on main.

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           
Flag Coverage Δ
windows-latest 66.38% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

m-aXimilian
m-aXimilian previously approved these changes Dec 8, 2025
Copy link
Copy Markdown
Contributor

@m-aXimilian m-aXimilian left a comment

Choose a reason for hiding this comment

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

The two remaining Copilot suggestions seem legitimate to me.
Other than that LGTM.

m-aXimilian
m-aXimilian previously approved these changes Dec 10, 2025
Copy link
Copy Markdown
Contributor

@m-aXimilian m-aXimilian left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@ptahmose ptahmose merged commit 4746709 into ZEISS:main Dec 10, 2025
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla Contributor License Agreement sent to Admin

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants