Skip to content

Commit 5700c0e

Browse files
authored
chore: add reference and faq
Signed-off-by: Shabareesh Shetty <[email protected]>
1 parent 9c66e39 commit 5700c0e

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

docs/contributing/FAQ.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,6 @@ There are primarily two options for setting up your development environment to c
6565

6666
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].
6767

68-
TODO: Modify the dev container setup link to the exact file link once it is merged.
69-
7068
<a name="install-cppcheck"></a>
7169

7270
## 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
102100

103101
<a name="markdown-heading-length"></a>
104102

105-
## What should I do if Markdown linting on my commits fails because my headings exceed the maximum permissible length?
103+
## What should I do if linting on my commits fails because my headings exceed the maximum permissible length?
106104

107105
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:
108106

107+
- For Javascript Files
108+
109+
```javascript
110+
// eslint-disable-line max-len
111+
```
112+
113+
- [Reference PR for Javascript][javascript-len-ref]
114+
115+
- For Markdown Files
116+
109117
```markdown
110118
<!-- lint disable maximum-heading-length -->
111119
```
112120

113-
TODO: Can we add a reference PR link?
121+
- [Reference PR for Markdown][markdown-len-ref]
114122

115123
<a name="markdown-heading-length"></a>
116124

@@ -119,10 +127,10 @@ TODO: Can we add a reference PR link?
119127
Consider whether the number of parameters can be reduced. If reducing is not possible, disable the lint rule at the top level using:
120128

121129
```javascript
122-
/* eslint-disable max-params */
130+
// eslint-disable-line max-params
123131
```
124132

125-
TODO: Can we add a reference PR link?
133+
- [Reference PR for Javascript][javascript-params-ref]
126134

127135
<a name="pr-feedback"></a>
128136

@@ -399,6 +407,12 @@ For more `make` commands, refer to the [documentation][benchmark] on running ben
399407

400408
[make-commands]: https://github.com/stdlib-js/stdlib/tree/develop/tools/make/lib
401409

410+
[markdown-len-ref]: https://github.com/stdlib-js/stdlib/pull/5754/files#diff-8b632afc40c671b4097b2d9fc318b0b6eedcebddeff0e13aad0a4d68260505d8R94
411+
412+
[javascript-len-ref]: https://github.com/stdlib-js/stdlib/pull/5754/files#diff-71a4cffefbc20405eaf647ea47353b5561fd10fc032a214183f0c307c3dc4624R75
413+
414+
[javascript-params-ref]: https://github.com/stdlib-js/stdlib/pull/5754/files#diff-71a4cffefbc20405eaf647ea47353b5561fd10fc032a214183f0c307c3dc4624R75
415+
402416
</section>
403417

404418
<!-- /.links -->

0 commit comments

Comments
 (0)