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

readme config example syntax error #82

Closed
jpmcb opened this issue Oct 11, 2018 · 2 comments
Closed

readme config example syntax error #82

jpmcb opened this issue Oct 11, 2018 · 2 comments
Assignees

Comments

@jpmcb
Copy link

jpmcb commented Oct 11, 2018

In the README.md, the example JSON has a syntax errors with a misplaced quotation mark in the customHighlight object and should appear as:

"defaultHighlight": {
    "icon": "alert",
    "type": "text",
    "foreground": "red",
    "background": "white",
    "iconColour": "blue"
},
"customHighlight": {
    "TODO": {
        "icon": "check",
        "type": "line"
    },
    "FIXME": {
        "foreground": "black",
        "iconColour": "yellow"
    }
}

Further, as a new VS code user, after installing, I found the above example alittle confusing because it was missing the todo-tree object. Would it be beneficial for the example to be more verbose and appear like this?

"todo-tree.defaultHighlight": {
    "icon": "alert",
    "type": "text",
    "foreground": "red",
    "background": "white",
    "iconColour": "blue"
},
"todo-tree.customHighlight": {
    "TODO": {
        "icon": "check",
        "type": "line"
    },
    "FIXME": {
        "foreground": "black",
        "iconColour": "yellow"
    }
}
@Gruntfuggly
Copy link
Owner

Yes, you're right. I'll fix it for the next release. Thanks.

@Gruntfuggly Gruntfuggly self-assigned this Oct 11, 2018
@jpmcb
Copy link
Author

jpmcb commented Oct 11, 2018

Great! Thanks for the amazing work on this!

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

2 participants