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

Add detailed descriptions to Rules.md #1654

Closed
marcelofabri opened this issue Jul 2, 2017 · 1 comment
Closed

Add detailed descriptions to Rules.md #1654

marcelofabri opened this issue Jul 2, 2017 · 1 comment
Labels
enhancement Ideas for improvements of existing features and rules. wontfix Issues that became stale and were auto-closed by a bot.

Comments

@marcelofabri
Copy link
Collaborator

Now that #1107 was merged, we can work on improvements:

Add a detailedDescription: String? on RuleDescription that would be used to generate the docs.
All descriptions currently were thought for console and Xcode usage and we should go into more details in the docs. @jpsim did an awesome job on the 0.14 release blog post that could be used as an inspiration.
@marcelofabri marcelofabri added the enhancement Ideas for improvements of existing features and rules. label Jul 2, 2017
@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
Assignees
No one assigned
Labels
enhancement Ideas for improvements of existing features and rules. wontfix Issues that became stale and were auto-closed by a bot.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@marcelofabri