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
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ limitations under the License.
27
27
-[How can I set up my development environment to contribute to stdlib?](#setup-dev-environment)
28
28
-[How can I install cppcheck?](#install-cppcheck)
29
29
-[I am seeing different return values in the JavaScript and C implementation for the same implementation.](#js-vs-c-return-values)
30
-
-[What should I do if Markdown linting on my commits fails because my headings exceed the maximum permissible length?](#markdown-heading-length)
30
+
-[What should I do if linting on my commits fails because my headings or lines exceed the maximum permissible length?](#markdown-heading-length)
31
31
-[What should I do if Javascript linting on my commits fails because my function exceed the maximum permissible number of parameters?](#max-params)
32
32
-[I have opened a pull request, where can I seek feedback?](#pr-feedback)
33
33
-[I need to generate fixtures for my tests. How can I do that, and what are the best references for inspiration?](#generate-fixtures)
@@ -100,7 +100,7 @@ If they pass, adjust the tolerance and add a note to the C tests indicating that
100
100
101
101
<aname="markdown-heading-length"></a>
102
102
103
-
## What should I do if 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 or lintings exceed the maximum permissible length?
104
104
105
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:
106
106
@@ -110,15 +110,15 @@ Consider whether the heading can be shortened by renaming variables (e.g., chang
110
110
// eslint-disable-line max-len
111
111
```
112
112
113
-
-[Reference PR for Javascript][javascript-len-ref]
113
+
[Reference PR][javascript-len-ref]
114
114
115
115
- For Markdown Files
116
116
117
117
```markdown
118
118
<!-- lint disable maximum-heading-length -->
119
119
```
120
120
121
-
-[Reference PR for Markdown][markdown-len-ref]
121
+
[Reference PR][markdown-len-ref]
122
122
123
123
<aname="markdown-heading-length"></a>
124
124
@@ -130,7 +130,7 @@ Consider whether the number of parameters can be reduced. If reducing is not pos
130
130
// eslint-disable-line max-params
131
131
```
132
132
133
-
-[Reference PR for Javascript][javascript-params-ref]
0 commit comments