Skip to content

Commit 9c66e39

Browse files
committed
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 ---
1 parent 4b27caa commit 9c66e39

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/contributing/FAQ.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ limitations under the License.
2828
- [How can I install cppcheck?](#install-cppcheck)
2929
- [I am seeing different return values in the JavaScript and C implementation for the same implementation.](#js-vs-c-return-values)
3030
- [What should I do if Markdown linting on my commits fails because my headings exceed the maximum permissible length?](#markdown-heading-length)
31+
- [What should I do if Javascript linting on my commits fails because my function exceed the maximum permissible number of parameters?](#max-params)
3132
- [I have opened a pull request, where can I seek feedback?](#pr-feedback)
3233
- [I need to generate fixtures for my tests. How can I do that, and what are the best references for inspiration?](#generate-fixtures)
3334
- [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
111112

112113
TODO: Can we add a reference PR link?
113114

115+
<a name="markdown-heading-length"></a>
116+
117+
## What should I do if Javascript linting on my commits fails because my headings exceed the maximum permissible number of parameters?
118+
119+
Consider whether the number of parameters can be reduced. If reducing is not possible, disable the lint rule at the top level using:
120+
121+
```javascript
122+
/* eslint-disable max-params */
123+
```
124+
125+
TODO: Can we add a reference PR link?
126+
114127
<a name="pr-feedback"></a>
115128

116129
## I have opened a pull request, where can I seek feedback?

0 commit comments

Comments
 (0)