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

fix: Change error handling of NameGenerator #439

Merged
merged 1 commit into from
Jan 19, 2025

Conversation

EttyKitty
Copy link
Collaborator

@EttyKitty EttyKitty commented Jan 18, 2025

Description of changes

  • Move error handling in the NameGenerator constructor from trying the whole constructor to individual name generation functions.
  • Make error handling return error strings on catch.

Reasons for changes

  • The previous method was not catching the usual errors.

Related links

How have you tested your changes?

  • Compile
  • New game
  • Next turn

Copy link
Contributor

sourcery-ai bot commented Jan 18, 2025

Reviewer's Guide by Sourcery

The error handling in the NameGenerator constructor has been moved from a single try-catch block encompassing the entire constructor to individual try-catch blocks within each name generation function. This change ensures that errors during name generation are caught and handled correctly, preventing the entire constructor from failing.

File-Level Changes

Change Details Files
Move error handling to individual name generation functions.
  • Removed the try-catch block from the NameGenerator constructor.
  • Added try-catch blocks to SimpleNameGeneration, MultiSyllableNameGeneration, ComplexTitledName, and CompositeNameGeneration functions.
  • Added a default return value of "name_error" in the catch blocks.
scripts/NameGenerator/NameGenerator.gml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions bot added the PR: Fix This is a fix for a bug label Jan 18, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @EttyKitty - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

scripts/NameGenerator/NameGenerator.gml Show resolved Hide resolved
@OH296 OH296 merged commit b8a1182 into Adeptus-Dominus:main Jan 19, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: Fix This is a fix for a bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants