You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing/FAQ.md
+20-6Lines changed: 20 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,8 +65,6 @@ There are primarily two options for setting up your development environment to c
65
65
66
66
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].
67
67
68
-
TODO: Modify the dev container setup link to the exact file link once it is merged.
69
-
70
68
<aname="install-cppcheck"></a>
71
69
72
70
## 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
102
100
103
101
<aname="markdown-heading-length"></a>
104
102
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?
106
104
107
105
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:
108
106
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
+
109
117
```markdown
110
118
<!-- lint disable maximum-heading-length -->
111
119
```
112
120
113
-
TODO: Can we add a reference PR link?
121
+
-[Reference PR for Markdown][markdown-len-ref]
114
122
115
123
<aname="markdown-heading-length"></a>
116
124
@@ -119,10 +127,10 @@ TODO: Can we add a reference PR link?
119
127
Consider whether the number of parameters can be reduced. If reducing is not possible, disable the lint rule at the top level using:
120
128
121
129
```javascript
122
-
/* eslint-disable max-params*/
130
+
// eslint-disable-line max-params
123
131
```
124
132
125
-
TODO: Can we add a reference PR link?
133
+
-[Reference PR for Javascript][javascript-params-ref]
126
134
127
135
<aname="pr-feedback"></a>
128
136
@@ -399,6 +407,12 @@ For more `make` commands, refer to the [documentation][benchmark] on running ben
0 commit comments