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

Translator: Improve error messages in the translation process #46

Open
1 of 2 tasks
skytin1004 opened this issue Oct 17, 2024 · 0 comments
Open
1 of 2 tasks

Translator: Improve error messages in the translation process #46

skytin1004 opened this issue Oct 17, 2024 · 0 comments
Labels
core Related to any changes in core source files enhancement New feature or request good first issue Good for newcomers

Comments

@skytin1004
Copy link
Collaborator

skytin1004 commented Oct 17, 2024

Describe the feature you'd like

Description:
The current error messages shown during the translation process are not very descriptive and can be confusing for users. We would like to improve these messages so that users can better understand what went wrong and how to resolve the issue.

Task:

  1. Review the error messages in the following modules(src/co_op_translator/translators):
    • ProjectTranslator
    • MarkdownTranslator
    • ImageTranslator
  2. Improve any error messages that are unclear or lacking detail.
  3. Ensure that the new messages provide enough context for the user to take corrective action.
    • For example, if a file cannot be processed, the error message should include the file name and reason for the failure.
  4. Test the improved error messages by running the translation process on sample files with expected errors.

Example:

  • Current message: "Error processing file."
  • Improved message: "Error processing file 'example.md': Unsupported file format."

This is a great issue for first-time contributors who want to help make the user experience more friendly and informative.

Instructions:

  • Fork the repository and clone it locally.
  • Update the error messages in the relevant files.
  • Test your changes locally to ensure the new error messages work as expected.
  • Submit a pull request referencing this issue.

Problem this feature solves

No response

Alternatives considered

No response

Additional context

No response

Are you willing to submit a pull request to implement this feature?

  • I am willing to submit a pull request

Code of Conduct

  • I agree to follow this project's Code of Conduct
@skytin1004 skytin1004 added enhancement New feature or request good first issue Good for newcomers core Related to any changes in core source files labels Oct 17, 2024
@github-actions github-actions bot changed the title Improve error messages in the translation process Translator: Improve error messages in the translation process Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Related to any changes in core source files enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant