From 614ed23920e5f5d03c711d34fa7bfa5380b07120 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Tue, 1 Apr 2025 00:07:28 -0700 Subject: [PATCH] docs: remove outdated FAQ on shadowed declaration warning --- 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 --- --- docs/contributing/FAQ.md | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/docs/contributing/FAQ.md b/docs/contributing/FAQ.md index 7f031e05eff0..49428c29c9d3 100644 --- a/docs/contributing/FAQ.md +++ b/docs/contributing/FAQ.md @@ -31,7 +31,6 @@ limitations under the License. - [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) - [I am facing a `Uninitialized variable` linting error in my C files, how can I fix it?](#uninitialized-variable) - [I have the required packages in the expected paths, but I am still encountering an error like this while compiling the native add-on.](#compilation-error) - [When should I use decimals in examples, benchmarks, and documentation, and when should I avoid them?](#decimal-usage) @@ -145,23 +144,6 @@ Consider joining our [Gitter channel][stdlib-gitter]! We are proud to have a ver Tests are a crucial part of any standard library package. We take our goal of achieving 100% test coverage very seriously and expect your work to be backed by tests. Often, you may need to generate fixtures to validate your implementation against an existing reliable source. You can use Julia, R, Python, or other languages to generate fixtures. To see how we do this, refer to these example scripts: [Python fixture script][python-fixtures], [Julia fixture script][julia-fixtures]. - - -## I am facing a `Shadowed declaration` linting error in my C files, how can I fix it? - -```bash -STDLIB_MATH_BASE_NAPI_MODULE_FF_F( stdlib_base_gcdf ) ^ -/home/runner/work/stdlib/stdlib/lib/node_modules/@stdlib/math/base/special/gcdf/include/stdlib/math/base/special/gcdf.h:32:7: -note: Shadowed declaration float stdlib_base_gcdf( const float a, const float b ); -``` - -You can suppress that warning by adding a `// cppcheck-suppress shadowFunction` comment above the function. For example: - -```c -// cppcheck-suppress shadowFunction -STDLIB_MATH_BASE_NAPI_MODULE_FF_F( stdlib_base_gcdf ) -``` - ## I am facing a `Uninitialized variable` linting error in my C files, how can I fix it?