Skip to content

Commit 31cc3f1

Browse files
authored
Regenerate docs and remove missing file from example to let grind test pass (#1331)
1 parent 1f6f9ed commit 31cc3f1

File tree

12 files changed

+52
-32
lines changed

12 files changed

+52
-32
lines changed

testing/test_package/lib/example.dart

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,8 +222,6 @@ class ConstantCat implements Cat {
222222
/// {@example dog/food}
223223
/// {@example dog/food.txt region=meat}
224224
///
225-
/// {@example test.html}
226-
///
227225
/// {@example test.dart region=template lang=html}
228226
///
229227
/// {@example test.dart region=}

testing/test_package_docs/ex/Dog-class.html

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,6 @@ <h5><a href="ex/ex-library.html">ex</a></h5>
144144
A selection of dog flavors:</p><ul><li>beef</li><li>poultry</li></ul>
145145
<pre class="language-html prettyprint"><code class="language-html">&lt;h1&gt;Hello &lt;b&gt;World&lt;/b&gt;!&lt;/h1&gt;
146146
</code></pre>
147-
<pre class="language-html prettyprint"><code class="language-html">&lt;h1&gt;Hello &lt;b&gt;World&lt;/b&gt;!&lt;/h1&gt;
148-
</code></pre>
149147
<pre class="language-dart prettyprint"><code class="language-dart">var test = 1;
150148
</code></pre>
151149
<pre class="prettyprint language-dart"><code>var test = 1;

testing/test_package_docs/fake/ExtraSpecialList/fillRange.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,10 @@ <h5><a href="fake/ExtraSpecialList-class.html">ExtraSpecialList</a></h5>
155155
<section class="desc markdown">
156156
<p>Sets the objects in the range <code>start</code> inclusive to <code>end</code> exclusive
157157
to the given <code>fillValue</code>.</p>
158-
<p>An error occurs if <code>start</code>..<code>end</code> is not a valid range for <code>this</code>.</p>
158+
<p>The provide range, given by <code>start</code> and <code>end</code>, must be valid.
159+
A range from <code>start</code> to <code>end</code> is valid if <code>0 &lt;= start &lt;= end &lt;= len</code>, where
160+
<code>len</code> is this list's <code>length</code>. The range starts at <code>start</code> and has length
161+
<code>end - start</code>. An empty range (with <code>end == start</code>) is valid.</p>
159162
</section>
160163

161164

testing/test_package_docs/fake/ExtraSpecialList/getRange.html

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -155,11 +155,13 @@ <h5><a href="fake/ExtraSpecialList-class.html">ExtraSpecialList</a></h5>
155155
<section class="desc markdown">
156156
<p>Returns an <code>Iterable</code> that iterates over the objects in the range
157157
<code>start</code> inclusive to <code>end</code> exclusive.</p>
158-
<p>An error occurs if <code>end</code> is before <code>start</code>.</p>
159-
<p>An error occurs if the <code>start</code> and <code>end</code> are not valid ranges at the time
160-
of the call to this method. The returned <code>Iterable</code> behaves like
161-
<code>skip(start).take(end - start)</code>. That is, it does not throw exceptions
162-
if <code>this</code> changes size.</p>
158+
<p>The provide range, given by <code>start</code> and <code>end</code>, must be valid at the time
159+
of the call.</p>
160+
<p>A range from <code>start</code> to <code>end</code> is valid if <code>0 &lt;= start &lt;= end &lt;= len</code>, where
161+
<code>len</code> is this list's <code>length</code>. The range starts at <code>start</code> and has length
162+
<code>end - start</code>. An empty range (with <code>end == start</code>) is valid.</p>
163+
<p>The returned <code>Iterable</code> behaves like <code>skip(start).take(end - start)</code>.
164+
That is, it does <em>not</em> throw if this list changes size.</p>
163165
<pre class="prettyprint language-dart"><code>List&lt;String&gt; colors = ['red', 'green', 'blue', 'orange', 'pink'];
164166
Iterable&lt;String&gt; range = colors.getRange(1, 4);
165167
range.join(', '); // 'green, blue, orange'

testing/test_package_docs/fake/ExtraSpecialList/removeRange.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,10 @@ <h5><a href="fake/ExtraSpecialList-class.html">ExtraSpecialList</a></h5>
154154
</section>
155155
<section class="desc markdown">
156156
<p>Removes the objects in the range <code>start</code> inclusive to <code>end</code> exclusive.</p>
157-
<p>The <code>start</code> and <code>end</code> indices must be in the range
158-
<code>0 ≤ index ≤ length</code>, and <code>start ≤ end</code>.</p>
157+
<p>The provide range, given by <code>start</code> and <code>end</code>, must be valid.
158+
A range from <code>start</code> to <code>end</code> is valid if <code>0 &lt;= start &lt;= end &lt;= len</code>, where
159+
<code>len</code> is this list's <code>length</code>. The range starts at <code>start</code> and has length
160+
<code>end - start</code>. An empty range (with <code>end == start</code>) is valid.</p>
159161
<p>Throws an <code>UnsupportedError</code> if this is a fixed-length list. In that case
160162
the list is not modified.</p>
161163
</section>

testing/test_package_docs/fake/ExtraSpecialList/replaceRange.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,10 @@ <h5><a href="fake/ExtraSpecialList-class.html">ExtraSpecialList</a></h5>
159159
list.replaceRange(1, 4, [6, 7]);
160160
list.join(', '); // '1, 6, 7, 5'
161161
</code></pre>
162-
<p>An error occurs if <code>start</code>..<code>end</code> is not a valid range for <code>this</code>.</p>
162+
<p>The provide range, given by <code>start</code> and <code>end</code>, must be valid.
163+
A range from <code>start</code> to <code>end</code> is valid if <code>0 &lt;= start &lt;= end &lt;= len</code>, where
164+
<code>len</code> is this list's <code>length</code>. The range starts at <code>start</code> and has length
165+
<code>end - start</code>. An empty range (with <code>end == start</code>) is valid.</p>
163166
<p>This method does not work on fixed-length lists, even when <code>replacement</code>
164167
has the same number of elements as the replaced range. In that case use
165168
<code>setRange</code> instead.</p>

testing/test_package_docs/fake/ExtraSpecialList/setRange.html

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -162,13 +162,15 @@ <h5><a href="fake/ExtraSpecialList-class.html">ExtraSpecialList</a></h5>
162162
list1.setRange(1, 3, list2, 3);
163163
list1.join(', '); // '1, 8, 9, 4'
164164
</code></pre>
165-
<p>The <code>start</code> and <code>end</code> indices must satisfy <code>0 ≤ start ≤ end ≤ length</code>.
166-
If <code>start</code> equals <code>end</code>, this method has no effect.</p>
165+
<p>The provide range, given by <code>start</code> and <code>end</code>, must be valid.
166+
A range from <code>start</code> to <code>end</code> is valid if <code>0 &lt;= start &lt;= end &lt;= len</code>, where
167+
<code>len</code> is this list's <code>length</code>. The range starts at <code>start</code> and has length
168+
<code>end - start</code>. An empty range (with <code>end == start</code>) is valid.</p>
167169
<p>The <code>iterable</code> must have enough objects to fill the range from <code>start</code>
168170
to <code>end</code> after skipping <code>skipCount</code> objects.</p>
169-
<p>If <code>iterable</code> is this list, the operation will copy the elements originally
170-
in the range from <code>skipCount</code> to <code>skipCount + (end - start)</code> to the
171-
range <code>start</code> to <code>end</code>, even if the two ranges overlap.</p>
171+
<p>If <code>iterable</code> is this list, the operation will copies the elements
172+
originally in the range from <code>skipCount</code> to <code>skipCount + (end - start)</code> to
173+
the range <code>start</code> to <code>end</code>, even if the two ranges overlap.</p>
172174
<p>If <code>iterable</code> depends on this list in some other way, no guarantees are
173175
made.</p>
174176
</section>

testing/test_package_docs/fake/SpecialList/fillRange.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,10 @@ <h5><a href="fake/SpecialList-class.html">SpecialList</a></h5>
155155
<section class="desc markdown">
156156
<p>Sets the objects in the range <code>start</code> inclusive to <code>end</code> exclusive
157157
to the given <code>fillValue</code>.</p>
158-
<p>An error occurs if <code>start</code>..<code>end</code> is not a valid range for <code>this</code>.</p>
158+
<p>The provide range, given by <code>start</code> and <code>end</code>, must be valid.
159+
A range from <code>start</code> to <code>end</code> is valid if <code>0 &lt;= start &lt;= end &lt;= len</code>, where
160+
<code>len</code> is this list's <code>length</code>. The range starts at <code>start</code> and has length
161+
<code>end - start</code>. An empty range (with <code>end == start</code>) is valid.</p>
159162
</section>
160163

161164

testing/test_package_docs/fake/SpecialList/getRange.html

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -155,11 +155,13 @@ <h5><a href="fake/SpecialList-class.html">SpecialList</a></h5>
155155
<section class="desc markdown">
156156
<p>Returns an <code>Iterable</code> that iterates over the objects in the range
157157
<code>start</code> inclusive to <code>end</code> exclusive.</p>
158-
<p>An error occurs if <code>end</code> is before <code>start</code>.</p>
159-
<p>An error occurs if the <code>start</code> and <code>end</code> are not valid ranges at the time
160-
of the call to this method. The returned <code>Iterable</code> behaves like
161-
<code>skip(start).take(end - start)</code>. That is, it does not throw exceptions
162-
if <code>this</code> changes size.</p>
158+
<p>The provide range, given by <code>start</code> and <code>end</code>, must be valid at the time
159+
of the call.</p>
160+
<p>A range from <code>start</code> to <code>end</code> is valid if <code>0 &lt;= start &lt;= end &lt;= len</code>, where
161+
<code>len</code> is this list's <code>length</code>. The range starts at <code>start</code> and has length
162+
<code>end - start</code>. An empty range (with <code>end == start</code>) is valid.</p>
163+
<p>The returned <code>Iterable</code> behaves like <code>skip(start).take(end - start)</code>.
164+
That is, it does <em>not</em> throw if this list changes size.</p>
163165
<pre class="prettyprint language-dart"><code>List&lt;String&gt; colors = ['red', 'green', 'blue', 'orange', 'pink'];
164166
Iterable&lt;String&gt; range = colors.getRange(1, 4);
165167
range.join(', '); // 'green, blue, orange'

testing/test_package_docs/fake/SpecialList/removeRange.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,10 @@ <h5><a href="fake/SpecialList-class.html">SpecialList</a></h5>
154154
</section>
155155
<section class="desc markdown">
156156
<p>Removes the objects in the range <code>start</code> inclusive to <code>end</code> exclusive.</p>
157-
<p>The <code>start</code> and <code>end</code> indices must be in the range
158-
<code>0 ≤ index ≤ length</code>, and <code>start ≤ end</code>.</p>
157+
<p>The provide range, given by <code>start</code> and <code>end</code>, must be valid.
158+
A range from <code>start</code> to <code>end</code> is valid if <code>0 &lt;= start &lt;= end &lt;= len</code>, where
159+
<code>len</code> is this list's <code>length</code>. The range starts at <code>start</code> and has length
160+
<code>end - start</code>. An empty range (with <code>end == start</code>) is valid.</p>
159161
<p>Throws an <code>UnsupportedError</code> if this is a fixed-length list. In that case
160162
the list is not modified.</p>
161163
</section>

0 commit comments

Comments
 (0)