Skip to content

Commit 8ade7ee

Browse files
doc: make parameter names consistent in docs for std.substr
1 parent ace4d74 commit 8ade7ee

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

doc/_stdlib_gen/stdlib-content.jsonnet

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -219,14 +219,14 @@ local exampleDocMultiline(mid, ex) =
219219
availableSince: '0.10.0',
220220
description: html.paragraphs([
221221
|||
222-
Returns a string that is the part of <code>s</code> that starts at offset <code>from</code>
223-
and is <code>len</code> codepoints long. If the string <code>s</code> is shorter than
222+
Returns a string that is the part of <code>str</code> that starts at offset <code>from</code>
223+
and is <code>len</code> codepoints long. If the string <code>str</code> is shorter than
224224
<code>from+len</code>, the suffix starting at position <code>from</code> will be returned.
225225
|||,
226226
|||
227-
The slice operator (e.g., <code>s[from:to]</code>) can also be used on strings, as an alternative
228-
to this function. However, note that the slice operator takes a start and an end index, but
229-
<code>std.substr</code> takes a start index and a length.
227+
The slice operator (e.g., <code>str[from:to]</code>) can also be used on strings, as an
228+
alternative to this function. However, note that the slice operator takes a start and an
229+
end index, but <code>std.substr</code> takes a start index and a length.
230230
|||,
231231
]),
232232
},

doc/ref/stdlib.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -463,14 +463,14 @@ <h4 id="substr">
463463
</em>
464464
</p>
465465
<p>
466-
Returns a string that is the part of <code>s</code> that starts at offset <code>from</code>
467-
and is <code>len</code> codepoints long. If the string <code>s</code> is shorter than
466+
Returns a string that is the part of <code>str</code> that starts at offset <code>from</code>
467+
and is <code>len</code> codepoints long. If the string <code>str</code> is shorter than
468468
<code>from+len</code>, the suffix starting at position <code>from</code> will be returned.
469469
</p>
470470
<p>
471-
The slice operator (e.g., <code>s[from:to]</code>) can also be used on strings, as an alternative
472-
to this function. However, note that the slice operator takes a start and an end index, but
473-
<code>std.substr</code> takes a start index and a length.
471+
The slice operator (e.g., <code>str[from:to]</code>) can also be used on strings, as an
472+
alternative to this function. However, note that the slice operator takes a start and an
473+
end index, but <code>std.substr</code> takes a start index and a length.
474474
</p>
475475

476476
</div>

0 commit comments

Comments
 (0)