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

chore: improve warning message for returning a constant value #4106

Merged
merged 1 commit into from
Jan 22, 2024

Conversation

TomAFrench
Copy link
Member

Description

Problem*

Resolves

Summary*

This message is a bit strong for a warning (constant return values are technically allowed, there's just generally not much reason for them). It also doesn't give much information on why they may not be a good idea.

I've updated the warning to something which I think is more useful. Happy to take feedback on this however.

Additional Context

Documentation*

Check one:

  • No documentation needed.
  • Documentation included in this PR.
  • [Exceptional Case] Documentation to be submitted in a separate PR.

PR Checklist*

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

@TomAFrench TomAFrench requested a review from guipublic January 22, 2024 14:08
@TomAFrench
Copy link
Member Author

Tagging Guillaume as he added this warning originally.

@kevaundray kevaundray added this pull request to the merge queue Jan 22, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 22, 2024
@TomAFrench TomAFrench added this pull request to the merge queue Jan 22, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 22, 2024
@TomAFrench TomAFrench added this pull request to the merge queue Jan 22, 2024
Merged via the queue into master with commit bb1aa68 Jan 22, 2024
31 checks passed
@TomAFrench TomAFrench deleted the tf/improve-constant-value-error branch January 22, 2024 18:24
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