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

New unused-return-enum documentation #315

Merged
merged 2 commits into from
Aug 12, 2024

Conversation

tomasavola
Copy link
Contributor

No description provided.

@tomasavola tomasavola added the documentation Improvements or additions to documentation label Aug 8, 2024
@tomasavola tomasavola self-assigned this Aug 8, 2024
Copy link

github-actions bot commented Aug 8, 2024

📘 Documentation Test Summary 📘

✅ The test build of the documentation has completed successfully!
📝 The changes will be published upon merge to the main branch.


If definitions of `Err()` and/or `Ok()` are in the code but do not flow to the return value due to the definition of a variable or because they are defined in a dead code block, the warning will not be shown. If the definitions are made in an auxiliary method, the warning will be shown, resulting in a false positive.
If any of the variants (Ok/Err) is not used, the code could be simplified or it could imply a bug.
Copy link
Collaborator

Choose a reason for hiding this comment

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

If either variant (Ok or Err) is not used in the code, it could indicate that the Result type is unnecessary and that the code could be simplified. Alternatively, it might suggest a bug where a possible outcome is not being handled properly.

@matiascabello matiascabello merged commit 4e58160 into main Aug 12, 2024
2 checks passed
@matiascabello matiascabello deleted the migrate-unused-return-enum-documentation branch August 12, 2024 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants