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

Add a help property to rule #261

Open
ghost opened this issue Aug 25, 2016 · 0 comments
Open

Add a help property to rule #261

ghost opened this issue Aug 25, 2016 · 0 comments

Comments

@ghost
Copy link

ghost commented Aug 25, 2016

The rule object has a helpUri property. For scenarios where a rule's help is not available via a URI, it would be nice if rule had a help property whose value was an object specifying the MIME type and text of the help content, for example:

rules: {
  "EX0001": {
    "id": "EX0001",
    "name": "DontDoBadThings",
    "help": {
      "mimeType": "text/markdown",
      "text": "# Rule EX0001: Don't do bad things\nIt is _really_ not nice to do bad things."
    }
  }
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

0 participants