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.

Sign up for GitHub

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

Jump to bottom

Feature request: Add a rationale to the rule description #4811

Open
2 tasks done
mildm8nnered opened this issue Mar 11, 2023 · 0 comments
Open
2 tasks done

Feature request: Add a rationale to the rule description #4811

mildm8nnered opened this issue Mar 11, 2023 · 0 comments
Labels
discussion Topics that cannot be categorized as bugs or enhancements yet. They require further discussions. documentation Issues related to documentation, either from the tooling side or content-wise. enhancement Ideas for improvements of existing features and rules.

Comments

@mildm8nnered
Copy link
Collaborator

New Issue Checklist

Describe the bug

The rule descriptions are quite sparse, and especially for novices, it may be very unclear what the motivation behind a given rule is, and why it might, or might not be, a good idea to enable or disable it.

The idea would be to add a text block to the rule descriptions that could be displayed in the documentation, explaining the rationale behind the rule, possibly with links etc.

Faux Pas (http://fauxpasapp.com) has a feature like this:

Screenshot 2023-03-11 at 16 58 40

Even better would be if there was some way to jump directly to this from the warnings displayed in Xcode.
@SimplyDanny SimplyDanny added enhancement Ideas for improvements of existing features and rules. discussion Topics that cannot be categorized as bugs or enhancements yet. They require further discussions. documentation Issues related to documentation, either from the tooling side or content-wise. labels Mar 11, 2023
@mildm8nnered mildm8nnered mentioned this issue Jul 20, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
discussion Topics that cannot be categorized as bugs or enhancements yet. They require further discussions. documentation Issues related to documentation, either from the tooling side or content-wise. enhancement Ideas for improvements of existing features and rules.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mildm8nnered @SimplyDanny