docs: use shorthand property name in example #16180
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The text that introduces the config example says "you can also shorten the configuration to this", but in the config example that follows nothing is shorter than in the previous config example. This commit fixes the config example by using a shorthand property name for jsdoc.
eslint-github-bot
bot
added
documentation
|
|
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
snitin315
added
accepted
crapStone
pushed a commit
to Calciumdibromid/CaBr2
that referenced
this pull request
Aug 23, 2022
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.21.0` -> `8.22.0`](https://renovatebot.com/diffs/npm/eslint/8.21.0/8.22.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.22.0`](https://github.com/eslint/eslint/releases/tag/v8.22.0) [Compare Source](eslint/eslint@v8.21.0...v8.22.0) #### Features - [`2b97607`](eslint/eslint@2b97607) feat: Implement caching for FlatESLint ([#​16190](eslint/eslint#16190)) (Nicholas C. Zakas) - [`fd5d3d3`](eslint/eslint@fd5d3d3) feat: add `methodsIgnorePattern` option to object-shorthand rule ([#​16185](eslint/eslint#16185)) (Milos Djermanovic) #### Documentation - [`9f5a752`](eslint/eslint@9f5a752) docs: optimize image assets ([#​16170](eslint/eslint#16170)) (Sam Chen) - [`61b2948`](eslint/eslint@61b2948) docs: add svgo command to pre commit hook ([#​16178](eslint/eslint#16178)) (Amaresh S M) - [`784096d`](eslint/eslint@784096d) docs: improve search result UI ([#​16187](eslint/eslint#16187)) (Sam Chen) - [`d0f4cb4`](eslint/eslint@d0f4cb4) docs: use shorthand property name in example ([#​16180](eslint/eslint#16180)) (Kevin Elliott) #### Chores - [`10a6e0e`](eslint/eslint@10a6e0e) chore: remove deploy workflow for playground ([#​16186](eslint/eslint#16186)) (Milos Djermanovic) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xNTYuMSIsInVwZGF0ZWRJblZlciI6IjMyLjE1Ni4xIn0=--> Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1506 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
eslint-github-bot
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
The text that introduces the relevant config example says "you can also shorten the configuration to this", but in the config example that follows nothing is shorter than in the previous config example. This PR fixes the config example by using a shorthand property name for
jsdoc(which I'm assuming was the intention).Is there anything you'd like reviewers to focus on?
No.