Add @example for defaultConfig #261
Conversation
lib/context.js
Outdated
| * @example <caption>Using a <code>defaultConfig</code> object.</caption> | ||
| * | ||
| * // Load config from .github/myapp.yml in the repository and combine with default config | ||
| * const config = await context.config('myapp.yml', {comment: 'Make sure to check all the specs.'}); |
There was a problem hiding this comment.
nit: ; is ❌ for standard
Also weird there are other places in this file not standard linted 🤔
There was a problem hiding this comment.
@hiimbex Good catch 👌 I think the reason we're seeing these not get linted is that the example code is actually in a comment instead of just being in the file itself.
There was a problem hiding this comment.
Is there an eslint plugin to check jsdoc comments similar to #252?
There was a problem hiding this comment.
@bkeepers a quick search seems to show plugins for linting JSDoc comments, but not specifically code in JSDoc examples.
I'll remove the ; in the snippets relevant to this PR, but it should obviously be consistent everywhere. Separate PR or this one?
There was a problem hiding this comment.
I'm having a vision of additional functionality for probot/linter lol. I'd go with separate 👍
Fixes #256 - add a JSDoc
@examplefor using thecontext.config()method with adefaultConfigobject. I did build the docs locally, LGTM but feel free to check it out yourself.🐟