From 9c66e393522e10c79f7142bd333b04fbc469b643 Mon Sep 17 00:00:00 2001 From: ShabiShett07 Date: Wed, 19 Mar 2025 00:16:31 +0530 Subject: [PATCH 01/16] docs: add faq --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- docs/contributing/FAQ.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index 388137c0bac1..8fe4dff6b25e 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -28,6 +28,7 @@ limitations under the License. - [How can I install cppcheck?](#install-cppcheck) - [I am seeing different return values in the JavaScript and C implementation for the same implementation.](#js-vs-c-return-values) - [What should I do if Markdown linting on my commits fails because my headings exceed the maximum permissible length?](#markdown-heading-length) +- [What should I do if Javascript linting on my commits fails because my function exceed the maximum permissible number of parameters?](#max-params) - [I have opened a pull request, where can I seek feedback?](#pr-feedback) - [I need to generate fixtures for my tests. How can I do that, and what are the best references for inspiration?](#generate-fixtures) - [I am facing a `Shadowed declaration` linting error in my C files, how can I fix it?](#shadowed-declaration) @@ -111,6 +112,18 @@ Consider whether the heading can be shortened by renaming variables (e.g., chang TODO: Can we add a reference PR link? + + +## What should I do if Javascript linting on my commits fails because my headings exceed the maximum permissible number of parameters? + +Consider whether the number of parameters can be reduced. If reducing is not possible, disable the lint rule at the top level using: + +```javascript +/* eslint-disable max-params */ +``` + +TODO: Can we add a reference PR link? + ## I have opened a pull request, where can I seek feedback? From 5700c0e56f804258bb72ed6d7663ab801898e5a7 Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Wed, 19 Mar 2025 21:08:24 +0530 Subject: [PATCH 02/16] chore: add reference and faq Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- docs/contributing/FAQ.md | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index 8fe4dff6b25e..7dcd02a551a8 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -65,8 +65,6 @@ There are primarily two options for setting up your development environment to c Note: The dev container does not yet support ARM64 architectures. For more information, or if you're interested in adding ARM64 support, you can visit this [issue][devcontainer-issue]. -TODO: Modify the dev container setup link to the exact file link once it is merged. - ## How can I install cppcheck? @@ -102,15 +100,25 @@ If they pass, adjust the tolerance and add a note to the C tests indicating that -## What should I do if Markdown linting on my commits fails because my headings exceed the maximum permissible length? +## What should I do if linting on my commits fails because my headings exceed the maximum permissible length? Consider whether the heading can be shortened by renaming variables (e.g., changing `strideX` to `sx`). If shortening is not possible, disable the lint rule at the top level using: +- For Javascript Files + +```javascript +// eslint-disable-line max-len +``` + +- [Reference PR for Javascript][javascript-len-ref] + +- For Markdown Files + ```markdown ``` -TODO: Can we add a reference PR link? +- [Reference PR for Markdown][markdown-len-ref] @@ -119,10 +127,10 @@ TODO: Can we add a reference PR link? Consider whether the number of parameters can be reduced. If reducing is not possible, disable the lint rule at the top level using: ```javascript -/* eslint-disable max-params */ +// eslint-disable-line max-params ``` -TODO: Can we add a reference PR link? +- [Reference PR for Javascript][javascript-params-ref] @@ -399,6 +407,12 @@ For more `make` commands, refer to the [documentation][benchmark] on running ben [make-commands]: https://github.com/stdlib-js/stdlib/tree/develop/tools/make/lib +[markdown-len-ref]: https://github.com/stdlib-js/stdlib/pull/5754/files#diff-8b632afc40c671b4097b2d9fc318b0b6eedcebddeff0e13aad0a4d68260505d8R94 + +[javascript-len-ref]: https://github.com/stdlib-js/stdlib/pull/5754/files#diff-71a4cffefbc20405eaf647ea47353b5561fd10fc032a214183f0c307c3dc4624R75 + +[javascript-params-ref]: https://github.com/stdlib-js/stdlib/pull/5754/files#diff-71a4cffefbc20405eaf647ea47353b5561fd10fc032a214183f0c307c3dc4624R75 + From fe395342837c33a4ed9da233e205559087422512 Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Thu, 20 Mar 2025 07:38:27 +0530 Subject: [PATCH 03/16] fix: unmatched errors Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- docs/contributing/FAQ.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index 7dcd02a551a8..584c3babbcf4 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -27,7 +27,7 @@ limitations under the License. - [How can I set up my development environment to contribute to stdlib?](#setup-dev-environment) - [How can I install cppcheck?](#install-cppcheck) - [I am seeing different return values in the JavaScript and C implementation for the same implementation.](#js-vs-c-return-values) -- [What should I do if Markdown linting on my commits fails because my headings exceed the maximum permissible length?](#markdown-heading-length) +- [What should I do if linting on my commits fails because my headings or lines exceed the maximum permissible length?](#markdown-heading-length) - [What should I do if Javascript linting on my commits fails because my function exceed the maximum permissible number of parameters?](#max-params) - [I have opened a pull request, where can I seek feedback?](#pr-feedback) - [I need to generate fixtures for my tests. How can I do that, and what are the best references for inspiration?](#generate-fixtures) @@ -100,7 +100,7 @@ If they pass, adjust the tolerance and add a note to the C tests indicating that -## What should I do if linting on my commits fails because my headings exceed the maximum permissible length? +## What should I do if linting on my commits fails because my headings or lintings exceed the maximum permissible length? Consider whether the heading can be shortened by renaming variables (e.g., changing `strideX` to `sx`). If shortening is not possible, disable the lint rule at the top level using: @@ -110,7 +110,7 @@ Consider whether the heading can be shortened by renaming variables (e.g., chang // eslint-disable-line max-len ``` -- [Reference PR for Javascript][javascript-len-ref] +[Reference PR][javascript-len-ref] - For Markdown Files @@ -118,7 +118,7 @@ Consider whether the heading can be shortened by renaming variables (e.g., chang ``` -- [Reference PR for Markdown][markdown-len-ref] +[Reference PR][markdown-len-ref] @@ -130,7 +130,7 @@ Consider whether the number of parameters can be reduced. If reducing is not pos // eslint-disable-line max-params ``` -- [Reference PR for Javascript][javascript-params-ref] +[Reference PR][javascript-params-ref] From 98b158b13b967d25bab404e8691e07e2f9a7abf3 Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Thu, 20 Mar 2025 07:41:53 +0530 Subject: [PATCH 04/16] fix: change mismatched words Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- docs/contributing/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index 584c3babbcf4..5cb480d7e2c1 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -100,7 +100,7 @@ If they pass, adjust the tolerance and add a note to the C tests indicating that -## What should I do if linting on my commits fails because my headings or lintings exceed the maximum permissible length? +## What should I do if linting on my commits fails because my headings or lines exceed the maximum permissible length? Consider whether the heading can be shortened by renaming variables (e.g., changing `strideX` to `sx`). If shortening is not possible, disable the lint rule at the top level using: From 7dbc449d8030cd8503197fb592006441b56072d4 Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Thu, 20 Mar 2025 22:17:59 +0530 Subject: [PATCH 05/16] chore: add correct link Co-authored-by: Karan Anand <119553199+anandkaranubc@users.noreply.github.com> Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- docs/contributing/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index 5cb480d7e2c1..d21b2510cf14 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -407,7 +407,7 @@ For more `make` commands, refer to the [documentation][benchmark] on running ben [make-commands]: https://github.com/stdlib-js/stdlib/tree/develop/tools/make/lib -[markdown-len-ref]: https://github.com/stdlib-js/stdlib/pull/5754/files#diff-8b632afc40c671b4097b2d9fc318b0b6eedcebddeff0e13aad0a4d68260505d8R94 +[markdown-len-ref]: https://github.com/stdlib-js/stdlib/blob/78e0cfd8b6c0429a443b07fd39fa9dd53bf44d23/lib/node_modules/%40stdlib/lapack/base/dgttrf/README.md?plain=1#L94 [javascript-len-ref]: https://github.com/stdlib-js/stdlib/pull/5754/files#diff-71a4cffefbc20405eaf647ea47353b5561fd10fc032a214183f0c307c3dc4624R75 From 73ddba331c3a2e000901322c16fcd7a7cc9cb4e6 Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Thu, 20 Mar 2025 22:19:32 +0530 Subject: [PATCH 06/16] fix: appropriate word Co-authored-by: Karan Anand <119553199+anandkaranubc@users.noreply.github.com> Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- docs/contributing/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index d21b2510cf14..ada3e0e2db08 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -110,7 +110,7 @@ Consider whether the heading can be shortened by renaming variables (e.g., chang // eslint-disable-line max-len ``` -[Reference PR][javascript-len-ref] +[Reference Comment][javascript-len-ref] - For Markdown Files From 5d99338e636e096d2e3f20ede3d067738d8b9863 Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Thu, 20 Mar 2025 22:24:40 +0530 Subject: [PATCH 07/16] chore: change len ref link Co-authored-by: Karan Anand <119553199+anandkaranubc@users.noreply.github.com> Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- docs/contributing/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index ada3e0e2db08..8785ad305c38 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -409,7 +409,7 @@ For more `make` commands, refer to the [documentation][benchmark] on running ben [markdown-len-ref]: https://github.com/stdlib-js/stdlib/blob/78e0cfd8b6c0429a443b07fd39fa9dd53bf44d23/lib/node_modules/%40stdlib/lapack/base/dgttrf/README.md?plain=1#L94 -[javascript-len-ref]: https://github.com/stdlib-js/stdlib/pull/5754/files#diff-71a4cffefbc20405eaf647ea47353b5561fd10fc032a214183f0c307c3dc4624R75 +[javascript-len-ref]: https://github.com/stdlib-js/stdlib/blob/78e0cfd8b6c0429a443b07fd39fa9dd53bf44d23/lib/node_modules/%40stdlib/lapack/base/dgttrf/lib/base.js#L111 [javascript-params-ref]: https://github.com/stdlib-js/stdlib/pull/5754/files#diff-71a4cffefbc20405eaf647ea47353b5561fd10fc032a214183f0c307c3dc4624R75 From acc4db31f54ba86746d9a99df6f5333db778cef1 Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Thu, 20 Mar 2025 22:25:02 +0530 Subject: [PATCH 08/16] chore: change params ref link Co-authored-by: Karan Anand <119553199+anandkaranubc@users.noreply.github.com> Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- docs/contributing/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index 8785ad305c38..f99205d402a6 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -411,7 +411,7 @@ For more `make` commands, refer to the [documentation][benchmark] on running ben [javascript-len-ref]: https://github.com/stdlib-js/stdlib/blob/78e0cfd8b6c0429a443b07fd39fa9dd53bf44d23/lib/node_modules/%40stdlib/lapack/base/dgttrf/lib/base.js#L111 -[javascript-params-ref]: https://github.com/stdlib-js/stdlib/pull/5754/files#diff-71a4cffefbc20405eaf647ea47353b5561fd10fc032a214183f0c307c3dc4624R75 +[javascript-params-ref]: https://github.com/stdlib-js/stdlib/blob/78e0cfd8b6c0429a443b07fd39fa9dd53bf44d23/lib/node_modules/%40stdlib/lapack/base/dgttrf/lib/base.js#L75 From bfab5ef16c984a9e39b8a0ee6db903cfcb020251 Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Thu, 20 Mar 2025 22:25:33 +0530 Subject: [PATCH 09/16] chore: change of word Co-authored-by: Karan Anand <119553199+anandkaranubc@users.noreply.github.com> Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- docs/contributing/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index f99205d402a6..c61bea883c57 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -118,7 +118,7 @@ Consider whether the heading can be shortened by renaming variables (e.g., chang ``` -[Reference PR][markdown-len-ref] +[Reference Comment][markdown-len-ref] From 09580f1138d242431e1fc4240aebae13baf253fa Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Fri, 21 Mar 2025 12:09:16 +0530 Subject: [PATCH 10/16] fix: word error Co-authored-by: Karan Anand <119553199+anandkaranubc@users.noreply.github.com> Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- docs/contributing/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index c61bea883c57..18445d7e7504 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -130,7 +130,7 @@ Consider whether the number of parameters can be reduced. If reducing is not pos // eslint-disable-line max-params ``` -[Reference PR][javascript-params-ref] +[Reference Comment][javascript-params-ref] From ecfa0054cb12d178ecb5f5453852d9ddedf8f22a Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Fri, 21 Mar 2025 12:09:59 +0530 Subject: [PATCH 11/16] chore: added appropriate format Co-authored-by: Karan Anand <119553199+anandkaranubc@users.noreply.github.com> Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- docs/contributing/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index 18445d7e7504..df228ba9d587 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -102,7 +102,7 @@ If they pass, adjust the tolerance and add a note to the C tests indicating that ## What should I do if linting on my commits fails because my headings or lines exceed the maximum permissible length? -Consider whether the heading can be shortened by renaming variables (e.g., changing `strideX` to `sx`). If shortening is not possible, disable the lint rule at the top level using: +Consider whether the heading/line can be shortened by renaming variables (e.g., changing `strideX` to `sx`). If shortening is not possible, disable the lint rule at the top level using: - For Javascript Files From 650741d386c18b8a63fc5c0011dcec77f362def4 Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Fri, 21 Mar 2025 16:39:17 +0530 Subject: [PATCH 12/16] chore: add suggestions Co-authored-by: Karan Anand <119553199+anandkaranubc@users.noreply.github.com> Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- docs/contributing/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index df228ba9d587..29ebb344c554 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -28,7 +28,7 @@ limitations under the License. - [How can I install cppcheck?](#install-cppcheck) - [I am seeing different return values in the JavaScript and C implementation for the same implementation.](#js-vs-c-return-values) - [What should I do if linting on my commits fails because my headings or lines exceed the maximum permissible length?](#markdown-heading-length) -- [What should I do if Javascript linting on my commits fails because my function exceed the maximum permissible number of parameters?](#max-params) +- [What should I do if JavaScript linting on my commits fails because my function exceeds the maximum permissible number of parameters?](#max-params) - [I have opened a pull request, where can I seek feedback?](#pr-feedback) - [I need to generate fixtures for my tests. How can I do that, and what are the best references for inspiration?](#generate-fixtures) - [I am facing a `Shadowed declaration` linting error in my C files, how can I fix it?](#shadowed-declaration) From 7aed29bca2332fa873e449f749f1be84eb90aaf8 Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Fri, 21 Mar 2025 16:39:50 +0530 Subject: [PATCH 13/16] chore: add suggestions Co-authored-by: Karan Anand <119553199+anandkaranubc@users.noreply.github.com> Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- docs/contributing/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index 29ebb344c554..f5d2f080a798 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -104,7 +104,7 @@ If they pass, adjust the tolerance and add a note to the C tests indicating that Consider whether the heading/line can be shortened by renaming variables (e.g., changing `strideX` to `sx`). If shortening is not possible, disable the lint rule at the top level using: -- For Javascript Files +- For JavaScript files: ```javascript // eslint-disable-line max-len From 1e22156d54ac6370596b4ad0b65ae4eac94c6ffd Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Fri, 21 Mar 2025 16:40:08 +0530 Subject: [PATCH 14/16] chore: add suggestions Co-authored-by: Karan Anand <119553199+anandkaranubc@users.noreply.github.com> Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- docs/contributing/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index f5d2f080a798..f61cc6e60e6d 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -112,7 +112,7 @@ Consider whether the heading/line can be shortened by renaming variables (e.g., [Reference Comment][javascript-len-ref] -- For Markdown Files +- For Markdown files: ```markdown From aee78f9c64eedc2ec312f150d2849bd70f9cde15 Mon Sep 17 00:00:00 2001 From: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> Date: Fri, 21 Mar 2025 16:40:31 +0530 Subject: [PATCH 15/16] chore: add suggestions Co-authored-by: Karan Anand <119553199+anandkaranubc@users.noreply.github.com> Signed-off-by: Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com> --- docs/contributing/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index f61cc6e60e6d..e86a0feba0c7 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -122,7 +122,7 @@ Consider whether the heading/line can be shortened by renaming variables (e.g., -## What should I do if Javascript linting on my commits fails because my headings exceed the maximum permissible number of parameters? +## What should I do if JavaScript linting on my commits fails because my function exceeds the maximum permissible number of parameters? Consider whether the number of parameters can be reduced. If reducing is not possible, disable the lint rule at the top level using: From 66ca07a02135d63f4f04b7cd52b7b30bc32986a9 Mon Sep 17 00:00:00 2001 From: Karan Anand <119553199+anandkaranubc@users.noreply.github.com> Date: Fri, 21 Mar 2025 04:36:54 -0700 Subject: [PATCH 16/16] chore: apply suggestions from review Signed-off-by: Karan Anand <119553199+anandkaranubc@users.noreply.github.com> --- docs/contributing/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index e86a0feba0c7..4d0403e79c00 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -124,7 +124,7 @@ Consider whether the heading/line can be shortened by renaming variables (e.g., ## What should I do if JavaScript linting on my commits fails because my function exceeds the maximum permissible number of parameters? -Consider whether the number of parameters can be reduced. If reducing is not possible, disable the lint rule at the top level using: +Consider whether the number of parameters can be reduced. If reduction is not possible, disable the lint rule at the top level using: ```javascript // eslint-disable-line max-params