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

Suggestion: Add "comment" property in Examples to specify the context of the Rule #3125

Closed
PaulTaykalo opened this issue Feb 19, 2020 · 1 comment
Labels
wontfix Issues that became stale and were auto-closed by a bot.

Comments

@PaulTaykalo
Copy link
Collaborator

It is probably a good idea to have a comment for violating and non-viloating Examples that can be used as a "documentation" and can be used as a detailed description of what is the example about.
Now

        ↓import Foundation
        typealias Foo = CFData
        """, configuration: [
            "require_explicit_imports": true
        ])

After

        ↓import Foundation
        typealias Foo = CFData
        """, configuration: [
            "require_explicit_imports": true
        ],comment: "Using transitive type 'CFData' from CoreFoundation should require CoreFoundation import")
@stale
Copy link

stale bot commented Nov 8, 2020

This issue has been automatically marked as stale because it has not had any recent activity. Please comment to prevent this issue from being closed. Thank you for your contributions!

@stale stale bot added the wontfix Issues that became stale and were auto-closed by a bot. label Nov 8, 2020
@stale stale bot closed this as completed Nov 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix Issues that became stale and were auto-closed by a bot.
Projects
None yet
Development

No branches or pull requests

1 participant