docs: Add function call example for no-undefined #16712

elliot-huffman · 2022-12-26T19:37:00Z

Add a function call example on how to skip parameters the safe way

Prerequisites checklist

I have read the contributing guidelines.

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)

Add Examples for dunction parameter skipping

Is there anything you'd like reviewers to focus on?

eslint-github-bot · 2022-12-26T19:37:04Z

Hi @elliot-huffman!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
There should be a space following the initial tag and colon, for example 'feat: Message'.
The first letter of the tag should be in lowercase

To Fix: You can fix this problem by running git commit --amend, editing your commit message, and then running git push -f to update this pull request.

Read more about contributing to ESLint here

linux-foundation-easycla · 2022-12-26T19:37:05Z

The committers listed above are authorized under a signed CLA.

✅ login: elliot-huffman / name: Elliot Huffman (1ebf234)

netlify · 2022-12-26T19:37:12Z

✅ Deploy Preview for docs-eslint ready!

Name	Link
🔨 Latest commit	`9bd7900`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/63aa1955cee8b000088842ea
😎 Deploy Preview	https://deploy-preview-16712--docs-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

eslint-github-bot · 2022-12-26T19:38:48Z

Hi @elliot-huffman!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
There should be a space following the initial tag and colon, for example 'feat: Message'.
The first letter of the tag should be in lowercase

To Fix: You can fix this problem by running git commit --amend, editing your commit message, and then running git push -f to update this pull request.

Read more about contributing to ESLint here

eslint-github-bot · 2022-12-26T19:43:43Z

Hi @elliot-huffman!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
There should be a space following the initial tag and colon, for example 'feat: Message'.
The first letter of the tag should be in lowercase

To Fix: You can fix this problem by running git commit --amend, editing your commit message, and then running git push -f to update this pull request.

Read more about contributing to ESLint here

eslint-github-bot · 2022-12-26T19:56:45Z

Hi @elliot-huffman!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
There should be a space following the initial tag and colon, for example 'feat: Message'.
The first letter of the tag should be in lowercase

To Fix: You can fix this problem by running git commit --amend, editing your commit message, and then running git push -f to update this pull request.

Read more about contributing to ESLint here

Add a function call example on how to skip parameters the safe way

docs/src/rules/no-undefined.md

thx for the spelling fixes Co-authored-by: Amaresh S M <amareshsm13@gmail.com>

docs/src/rules/no-undefined.md

thx for the spelling fixes Co-authored-by: Amaresh S M <amareshsm13@gmail.com>

Remove the function definition to reduce docs complexity.

elliot-huffman · 2022-12-26T20:18:16Z

Fixed the above :)

elliot-huffman · 2022-12-26T20:26:47Z

Sorry about the double requests, this is my first time pull requesting this way.

amareshsm · 2022-12-26T20:28:08Z

@mdjermanovic suggested removing the definition comment. just mention Skips the first parameter

like this

// Skips the first parameter
bar(undefined, "lorem");

// Skips the first parameter
bar(void 0, "lorem");

Simplify the wording of the comments.

elliot-huffman · 2022-12-26T20:31:53Z

Fixed.

amareshsm

LGTM. Thanks 🚀

nzakas

Thanks for the submission. I'm not sure what the comments in the code examples are supposed to describe, so please take a look.

docs/src/rules/no-undefined.md

after much deliberation, the committee has decreed that there shall be no comments on the new examples!

mdjermanovic

LGTM, thanks!

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.30.0` -> `8.31.0`](https://renovatebot.com/diffs/npm/eslint/8.30.0/8.31.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.31.0`](https://github.com/eslint/eslint/releases/tag/v8.31.0) [Compare Source](eslint/eslint@v8.30.0...v8.31.0) #### Features - [`52c7c73`](eslint/eslint@52c7c73) feat: check assignment patterns in no-underscore-dangle ([#16693](eslint/eslint#16693)) (Milos Djermanovic) - [`b401cde`](eslint/eslint@b401cde) feat: add options to check destructuring in no-underscore-dangle ([#16006](eslint/eslint#16006)) (Morten Kaltoft) - [`30d0daf`](eslint/eslint@30d0daf) feat: group properties with values in parentheses in `key-spacing` ([#16677](eslint/eslint#16677)) (Francesco Trotta) #### Bug Fixes - [`35439f1`](eslint/eslint@35439f1) fix: correct syntax error in `prefer-arrow-callback` autofix ([#16722](eslint/eslint#16722)) (Francesco Trotta) - [`87b2470`](eslint/eslint@87b2470) fix: new instance of FlatESLint should load latest config file version ([#16608](eslint/eslint#16608)) (Milos Djermanovic) #### Documentation - [`4339dc4`](eslint/eslint@4339dc4) docs: Update README (GitHub Actions Bot) - [`4e4049c`](eslint/eslint@4e4049c) docs: optimize code block structure ([#16669](eslint/eslint#16669)) (Sam Chen) - [`54a7ade`](eslint/eslint@54a7ade) docs: do not escape code blocks of formatters examples ([#16719](eslint/eslint#16719)) (Sam Chen) - [`e5ecfef`](eslint/eslint@e5ecfef) docs: Add function call example for no-undefined ([#16712](eslint/eslint#16712)) (Elliot Huffman) - [`a3262f0`](eslint/eslint@a3262f0) docs: Add mastodon link ([#16638](eslint/eslint#16638)) (Amaresh S M) - [`a14ccf9`](eslint/eslint@a14ccf9) docs: clarify files property ([#16709](eslint/eslint#16709)) (Sam Chen) - [`3b29eb1`](eslint/eslint@3b29eb1) docs: fix npm link ([#16710](eslint/eslint#16710)) (Abdullah Osama) - [`a638673`](eslint/eslint@a638673) docs: fix search bar focus on `Esc` ([#16700](eslint/eslint#16700)) (Shanmughapriyan S) - [`f62b722`](eslint/eslint@f62b722) docs: country flag missing in windows ([#16698](eslint/eslint#16698)) (Shanmughapriyan S) - [`4d27ec6`](eslint/eslint@4d27ec6) docs: display zh-hans in the docs language switcher ([#16686](eslint/eslint#16686)) (Percy Ma) - [`8bda20e`](eslint/eslint@8bda20e) docs: remove manually maintained anchors ([#16685](eslint/eslint#16685)) (Percy Ma) - [`b68440f`](eslint/eslint@b68440f) docs: User Guide Getting Started expansion ([#16596](eslint/eslint#16596)) (Ben Perlmutter) #### Chores - [`65d4e24`](eslint/eslint@65d4e24) chore: Upgrade [@eslint/eslintrc](https://github.com/eslint/eslintrc)[@1](https://github.com/1).4.1 ([#16729](eslint/eslint#16729)) (Brandon Mills) - [`8d93081`](eslint/eslint@8d93081) chore: fix CI failure ([#16721](eslint/eslint#16721)) (Sam Chen) - [`8f17247`](eslint/eslint@8f17247) chore: Set up automatic updating of README ([#16717](eslint/eslint#16717)) (Nicholas C. Zakas) - [`4cd87cb`](eslint/eslint@4cd87cb) ci: bump actions/stale from 6 to 7 ([#16713](eslint/eslint#16713)) (dependabot\[bot]) - [`fd20c75`](eslint/eslint@fd20c75) chore: sort package.json scripts in alphabetical order ([#16705](eslint/eslint#16705)) (Darius Dzien) - [`10a5c78`](eslint/eslint@10a5c78) chore: update ignore patterns in `eslint.config.js` ([#16678](eslint/eslint#16678)) (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. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1697 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/eslint#16712

* docs: User Guide Getting Started expansion * docs: add options to check destructuring in no-underscore-dangle eslint/eslint#16006 * docs: adjust some words * docs: Add function call example for no-undefined eslint/eslint#16712 * docs: check assignment patterns in no-underscore-dangle eslint/eslint#16693 * update formatters * Apply suggestions from code review Co-authored-by: Strek <ssharishkumar@gmail.com> --------- Co-authored-by: Strek <ssharishkumar@gmail.com>

* docs: add options to check destructuring in no-underscore-dangle eslint/eslint#16006 * docs: check assignment patterns in no-underscore-dangle eslint/eslint#16693 * docs: use inline code for rule options name eslint/eslint#16768 * docs: ignore directives for no-fallthrough eslint/eslint#16757 * docs: IA Update page URL move eslint/eslint#16665 * update * feat: sync v8.31.0 (#94) * docs: User Guide Getting Started expansion * docs: add options to check destructuring in no-underscore-dangle eslint/eslint#16006 * docs: adjust some words * docs: Add function call example for no-undefined eslint/eslint#16712 * docs: check assignment patterns in no-underscore-dangle eslint/eslint#16693 * update formatters * Apply suggestions from code review Co-authored-by: Strek <ssharishkumar@gmail.com> --------- Co-authored-by: Strek <ssharishkumar@gmail.com> * docs: add options to check destructuring in no-underscore-dangle eslint/eslint#16006 * docs: IA Update page URL move eslint/eslint#16665 --------- Co-authored-by: Strek <ssharishkumar@gmail.com>

elliot-huffman requested a review from a team as a code owner December 26, 2022 19:37

eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Dec 26, 2022

elliot-huffman changed the title ~~Add Function Call Example~~ docs: Add Function Call Example Dec 26, 2022

mdjermanovic changed the title ~~docs: Add Function Call Example~~ docs: Add function call example for no-undefined Dec 26, 2022

mdjermanovic added rule Relates to ESLint's core rules documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Dec 26, 2022

docs: Add Function Call Example

f25156b

Add a function call example on how to skip parameters the safe way

elliot-huffman mentioned this pull request Dec 26, 2022

Rule Change: Add ability to ignore Undefined in Function Params #16711

Closed

1 task

amareshsm reviewed Dec 26, 2022

View reviewed changes

docs/src/rules/no-undefined.md Outdated Show resolved Hide resolved

amareshsm reviewed Dec 26, 2022

View reviewed changes

docs/src/rules/no-undefined.md Outdated Show resolved Hide resolved

Update docs/src/rules/no-undefined.md

7d3e51f

thx for the spelling fixes Co-authored-by: Amaresh S M <amareshsm13@gmail.com>

mdjermanovic reviewed Dec 26, 2022

View reviewed changes

docs/src/rules/no-undefined.md Outdated Show resolved Hide resolved

docs/src/rules/no-undefined.md Outdated Show resolved Hide resolved

elliot-huffman and others added 2 commits December 26, 2022 15:08

Update docs/src/rules/no-undefined.md

c8dd92f

thx for the spelling fixes Co-authored-by: Amaresh S M <amareshsm13@gmail.com>

Remove Function Def

66996b1

Remove the function definition to reduce docs complexity.

elliot-huffman requested review from mdjermanovic and amareshsm and removed request for mdjermanovic and amareshsm December 26, 2022 20:20

elliot-huffman requested review from mdjermanovic and removed request for amareshsm December 26, 2022 20:20

Simplify wording

c24fea1

Simplify the wording of the comments.

amareshsm approved these changes Dec 26, 2022

View reviewed changes

nzakas reviewed Dec 26, 2022

View reviewed changes

docs/src/rules/no-undefined.md Outdated Show resolved Hide resolved

docs/src/rules/no-undefined.md Outdated Show resolved Hide resolved

No comments it is

9bd7900

after much deliberation, the committee has decreed that there shall be no comments on the new examples!

elliot-huffman requested review from nzakas and mdjermanovic and removed request for mdjermanovic and nzakas December 26, 2022 22:28

mdjermanovic approved these changes Dec 27, 2022

View reviewed changes

mdjermanovic merged commit e5ecfef into eslint:main Dec 27, 2022
21 checks passed

elliot-huffman deleted the patch-1 branch December 27, 2022 16:23

kecrily added a commit to eslint/zh-hans.docs.eslint.org that referenced this pull request Feb 19, 2023

docs: Add function call example for no-undefined

a7afaf9

eslint/eslint#16712

docs: Add function call example for no-undefined #16712

docs: Add function call example for no-undefined #16712

elliot-huffman commented Dec 26, 2022 •

edited

eslint-github-bot bot commented Dec 26, 2022

linux-foundation-easycla bot commented Dec 26, 2022 •

edited

netlify bot commented Dec 26, 2022 •

edited

eslint-github-bot bot commented Dec 26, 2022

eslint-github-bot bot commented Dec 26, 2022

eslint-github-bot bot commented Dec 26, 2022

elliot-huffman commented Dec 26, 2022

elliot-huffman commented Dec 26, 2022

amareshsm commented Dec 26, 2022

elliot-huffman commented Dec 26, 2022

amareshsm left a comment

nzakas left a comment

mdjermanovic left a comment

docs: Add function call example for no-undefined #16712

docs: Add function call example for no-undefined #16712

Conversation

elliot-huffman commented Dec 26, 2022 • edited

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

What changes did you make? (Give an overview)

Is there anything you'd like reviewers to focus on?

eslint-github-bot bot commented Dec 26, 2022

linux-foundation-easycla bot commented Dec 26, 2022 • edited

netlify bot commented Dec 26, 2022 • edited

✅ Deploy Preview for docs-eslint ready!

eslint-github-bot bot commented Dec 26, 2022

eslint-github-bot bot commented Dec 26, 2022

eslint-github-bot bot commented Dec 26, 2022

elliot-huffman commented Dec 26, 2022

elliot-huffman commented Dec 26, 2022

amareshsm commented Dec 26, 2022

elliot-huffman commented Dec 26, 2022

amareshsm left a comment

Choose a reason for hiding this comment

nzakas left a comment

Choose a reason for hiding this comment

mdjermanovic left a comment

Choose a reason for hiding this comment

elliot-huffman commented Dec 26, 2022 •

edited

linux-foundation-easycla bot commented Dec 26, 2022 •

edited

netlify bot commented Dec 26, 2022 •

edited