Skip to content

Commit b3d21c0

Browse files
docs: remove outdated FAQ on shadowed declaration warning
PR-URL: #6487 Reviewed-by: Athan Reines <[email protected]>
1 parent 998b3ba commit b3d21c0

File tree

1 file changed

+0
-18
lines changed

1 file changed

+0
-18
lines changed

docs/contributing/FAQ.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ limitations under the License.
3131
- [What should I do if JavaScript linting on my commits fails because my function exceeds the maximum permissible number of parameters?](#max-params)
3232
- [I have opened a pull request, where can I seek feedback?](#pr-feedback)
3333
- [I need to generate fixtures for my tests. How can I do that, and what are the best references for inspiration?](#generate-fixtures)
34-
- [I am facing a `Shadowed declaration` linting error in my C files, how can I fix it?](#shadowed-declaration)
3534
- [I am facing a `Uninitialized variable` linting error in my C files, how can I fix it?](#uninitialized-variable)
3635
- [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)
3736
- [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
145144

146145
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].
147146

148-
<a name="shadowed-declaration"></a>
149-
150-
## I am facing a `Shadowed declaration` linting error in my C files, how can I fix it?
151-
152-
```bash
153-
STDLIB_MATH_BASE_NAPI_MODULE_FF_F( stdlib_base_gcdf ) ^
154-
/home/runner/work/stdlib/stdlib/lib/node_modules/@stdlib/math/base/special/gcdf/include/stdlib/math/base/special/gcdf.h:32:7:
155-
note: Shadowed declaration float stdlib_base_gcdf( const float a, const float b );
156-
```
157-
158-
You can suppress that warning by adding a `// cppcheck-suppress shadowFunction` comment above the function. For example:
159-
160-
```c
161-
// cppcheck-suppress shadowFunction
162-
STDLIB_MATH_BASE_NAPI_MODULE_FF_F( stdlib_base_gcdf )
163-
```
164-
165147
<a name="uninitialized-variable"></a>
166148

167149
## I am facing a `Uninitialized variable` linting error in my C files, how can I fix it?

0 commit comments

Comments
 (0)