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

Update main.rs #167

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update main.rs #167

wants to merge 3 commits into from

Conversation

mettete
Copy link

@mettete mettete commented Jan 6, 2024

Motivation

The main.rs file in the cryo_cli crate serves as the application's entry point. The existing implementation had opportunities for improvement in error handling and code readability. Specifically, the error handling varied based on build configurations (debug vs. release), and there was potential to enhance the overall structure and documentation of the code for better clarity and maintainability.

Solution

This pull request introduces several key changes to main.rs:

Changes made:

  • Reintroduced Build Configuration Handling: Added separate functions handle_error_with_report for handling errors with and without detailed error reporting, depending on the build configuration. This ensures a consistent approach to error handling across different build environments.
  • Streamlined Error Handling: Maintained a unified approach to error handling while respecting the differences between debug and release builds. This change enhances the reliability and predictability of the application's error responses.
  • Enhanced Readability: Improved the structure and readability of the code. The refactoring makes the main function and its error handling logic easier to understand and maintain, aiding both current maintenance and future development efforts.

These changes aim to enhance the overall quality of the cryo_cli crate, making it more robust and easier to work with for developers.

PR Checklist

  • Added Tests
  • Added Documentation
  • Breaking changes

Changes made:

Reintroduced Build Configuration Handling: Added separate functions handle_error_with_report for handling errors with and without detailed error reporting, depending on the build configuration.
Streamlined Error Handling: Maintained a unified approach to error handling while respecting the differences between debug and release builds.
Enhanced Readability: Improved the structure and readability of the code, making it easier to understand and maintain.
// handle release build
#[cfg(not(debug_assertions))]
{
println!("{}", e);
Copy link
Member

Choose a reason for hiding this comment

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

this line should not be removed by the refactor

@sslivkoff
Copy link
Member

hi. these changes seem good but it looks like a useful error printout was removed during the refactor

@mettete
Copy link
Author

mettete commented Feb 11, 2024

hi. these changes seem good but it looks like a useful error printout was removed during the refactor

added thanks for feedback

@mettete
Copy link
Author

mettete commented Apr 2, 2024

hi. these changes seem good but it looks like a useful error printout was removed during the refactor

is there a still any error

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.

2 participants