Release/0.4.0 #3

Merged
Qrashi merged 37 commits from release/0.4.0 into main 2026-01-15 17:38:07 +01:00
Qrashi commented 2026-01-13 23:17:26 +01:00 (Migrated from github.com)

So far, rename override_messages_stay_in_one_line to messages_stay_in_one_line (breaking)

Other updates are

  • Update documentation
  • Update Makefile

feature/left_middle_right_alignment will be merged later

So far, rename override_messages_stay_in_one_line to messages_stay_in_one_line (breaking) Other updates are * Update documentation * Update Makefile feature/left_middle_right_alignment will be merged later
copilot-pull-request-reviewer[bot] (Migrated from github.com) reviewed 2026-01-13 23:20:28 +01:00
copilot-pull-request-reviewer[bot] (Migrated from github.com) left a comment

Pull request overview

This pull request prepares the codebase for the 0.4.0 release by updating documentation and build configuration. The PR description mentions a breaking change renaming override_messages_stay_in_one_line to messages_stay_in_one_line, though the actual code changes for this appear to have been made in previous commits.

Changes:

  • Fixed package data configuration in pyproject.toml (corrected "singlejson" to "cliasi")
  • Updated example files to include proper import statements
  • Enhanced documentation with improved API references, color/symbol warnings, and formatting updates
  • Added format target to Makefile and completion messages for build tasks

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/cliasi/py.typed Added type marker file for PEP 561 compliance
pyproject.toml Fixed package data configuration from incorrect "singlejson" to "cliasi"
examples/exception_message.py Added explicit import statement with linter suppression comments
docs/source/message_types.rst Updated color codes, improved exception formatting display, and added terminal compatibility warning
docs/source/api/index.rst Enhanced API documentation with better type annotations and parameter descriptions
Makefile Renamed default target to "check", added "format" target, and included completion messages

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

## Pull request overview This pull request prepares the codebase for the 0.4.0 release by updating documentation and build configuration. The PR description mentions a breaking change renaming `override_messages_stay_in_one_line` to `messages_stay_in_one_line`, though the actual code changes for this appear to have been made in previous commits. **Changes:** - Fixed package data configuration in pyproject.toml (corrected "singlejson" to "cliasi") - Updated example files to include proper import statements - Enhanced documentation with improved API references, color/symbol warnings, and formatting updates - Added format target to Makefile and completion messages for build tasks ### Reviewed changes Copilot reviewed 5 out of 6 changed files in this pull request and generated 3 comments. <details> <summary>Show a summary per file</summary> | File | Description | | ---- | ----------- | | src/cliasi/py.typed | Added type marker file for PEP 561 compliance | | pyproject.toml | Fixed package data configuration from incorrect "singlejson" to "cliasi" | | examples/exception_message.py | Added explicit import statement with linter suppression comments | | docs/source/message_types.rst | Updated color codes, improved exception formatting display, and added terminal compatibility warning | | docs/source/api/index.rst | Enhanced API documentation with better type annotations and parameter descriptions | | Makefile | Renamed default target to "check", added "format" target, and included completion messages | </details> --- 💡 <a href="/IgnyteX-Labs/cliasi/new/main/.github/instructions?filename=*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
@ -8,2 +7,3 @@
The main interface for :mod:`~cliasi.cliasi`.
cliasi exports the :class:`~cliasi.Cliasi` instance :data:`~cliasi.cli`
cliasi exports the :class:`~cliasi.cliasi.Cliasi` instance :data:`~cliasi.cli`
copilot-pull-request-reviewer[bot] (Migrated from github.com) commented 2026-01-13 23:20:27 +01:00

Spelling error: "wether" should be "whether"

* :attr:`~cliasi.cliasi.Cliasi.messages_stay_in_one_line` - whether messages should stay in one line
Spelling error: "wether" should be "whether" ```suggestion * :attr:`~cliasi.cliasi.Cliasi.messages_stay_in_one_line` - whether messages should stay in one line ```
@ -55,11 +58,11 @@ If an exception is raised or a traceback is logged, it will be formatted using t
copilot-pull-request-reviewer[bot] (Migrated from github.com) commented 2026-01-13 23:20:27 +01:00

The line number in the traceback output should be updated to "line 6" to match the actual line number in the examples/exception_message.py file after the new import statements were added.

            </span>|<span style="color: #ff5959">   File "examples/exception_message.py", line 6, in &lt;module&gt;
The line number in the traceback output should be updated to "line 6" to match the actual line number in the examples/exception_message.py file after the new import statements were added. ```suggestion </span>|<span style="color: #ff5959"> File "examples/exception_message.py", line 6, in &lt;module&gt; ```
@ -1,2 +1,7 @@
# cliasi needs to be imported to intercept exceptions
# noinspection PyUnusedImports
# ruff: noqa: F401
import cliasi
copilot-pull-request-reviewer[bot] (Migrated from github.com) commented 2026-01-13 23:20:28 +01:00

Import of 'cliasi' is not used.

Import of 'cliasi' is not used.
copilot-pull-request-reviewer[bot] (Migrated from github.com) reviewed 2026-01-15 17:32:39 +01:00
copilot-pull-request-reviewer[bot] (Migrated from github.com) left a comment

Pull request overview

Copilot reviewed 32 out of 48 changed files in this pull request and generated 5 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

## Pull request overview Copilot reviewed 32 out of 48 changed files in this pull request and generated 5 comments. --- 💡 <a href="/IgnyteX-Labs/cliasi/new/main/.github/instructions?filename=*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
@ -4,3 +4,3 @@
all: lint typecheck test
check: lint format typecheck test
help:
copilot-pull-request-reviewer[bot] (Migrated from github.com) commented 2026-01-15 17:32:38 +01:00

The target name changed from 'all' to 'check', but this is not mentioned in the PR description. This could be a breaking change for CI/CD pipelines or developer workflows that rely on make all.

The target name changed from 'all' to 'check', but this is not mentioned in the PR description. This could be a breaking change for CI/CD pipelines or developer workflows that rely on `make all`.
@ -55,11 +58,11 @@ If an exception is raised or a traceback is logged, it will be formatted using t
copilot-pull-request-reviewer[bot] (Migrated from github.com) commented 2026-01-15 17:32:37 +01:00

There's a malformed HTML/text in the example output. 'examplfont-weight: bold"e error' should be 'example error'. This appears to be a copy-paste or formatting error.

            </span>|<span style="color: #ff5959"> ValueError: An example error</span>
There's a malformed HTML/text in the example output. 'examplfont-weight: bold"e error' should be 'example error'. This appears to be a copy-paste or formatting error. ```suggestion </span>|<span style="color: #ff5959"> ValueError: An example error</span> ```
@ -1,2 +1,7 @@
# cliasi needs to be imported to intercept exceptions
# noinspection PyUnusedImports
# ruff: noqa: F401
import cliasi
copilot-pull-request-reviewer[bot] (Migrated from github.com) commented 2026-01-15 17:32:39 +01:00

Import of 'cliasi' is not used.

Import of 'cliasi' is not used.
copilot-pull-request-reviewer[bot] (Migrated from github.com) commented 2026-01-15 17:32:37 +01:00

The comment explaining the -1 adjustment is on a separate line after the return statement, making it unreachable code. Move the comment to the line above or as an inline comment on line 41.

The comment explaining the `-1` adjustment is on a separate line after the return statement, making it unreachable code. Move the comment to the line above or as an inline comment on line 41.
@ -87,3 +87,3 @@
"default": ANIMATIONS_SYMBOLS,
"download": [["🢓", "", "", "", "", "", "_", "_"]],
"download": [["°", "", "", "", "", "", "_", "_"]],
}
copilot-pull-request-reviewer[bot] (Migrated from github.com) commented 2026-01-15 17:32:36 +01:00

Changed the first symbol in the download animation from '🢓' to '°'. While this is a visual change, consider whether '°' (degree symbol) is the intended symbol here, as it seems semantically different from the directional arrows that follow.

Changed the first symbol in the download animation from '🢓' to '°'. While this is a visual change, consider whether '°' (degree symbol) is the intended symbol here, as it seems semantically different from the directional arrows that follow.
Qrashi (Migrated from github.com) reviewed 2026-01-15 17:33:17 +01:00
@ -87,3 +87,3 @@
"default": ANIMATIONS_SYMBOLS,
"download": [["🢓", "", "", "", "", "", "_", "_"]],
"download": [["°", "", "", "", "", "", "_", "_"]],
}
Qrashi (Migrated from github.com) commented 2026-01-15 17:33:16 +01:00

The old character was buggy,

The old character was buggy,
Sign in to join this conversation.
No description provided.