Skip to content

Commit f10d469

Browse files
authored
Rev markdown (#1248)
* regen the sample docs * rev package versions
1 parent 0cc419a commit f10d469

File tree

47 files changed

+137
-141
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+137
-141
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
## unreleased
22
* fixed an issue with documenting libraries starting with `packages`
33
* upgraded our dependency on `html` to 0.13.0
4+
* upgraded our dependency on `package_config` and `markdown`
45

56
## 0.9.7+3
67
* Extended package_config dependency to include stable 1.0.0 api.

pubspec.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ packages:
126126
name: markdown
127127
url: "https://pub.dartlang.org"
128128
source: hosted
129-
version: "0.10.1"
129+
version: "0.11.0+1"
130130
matcher:
131131
description:
132132
name: matcher
@@ -162,7 +162,7 @@ packages:
162162
name: package_config
163163
url: "https://pub.dartlang.org"
164164
source: hosted
165-
version: "0.1.5"
165+
version: "1.0.0"
166166
package_resolver:
167167
description:
168168
name: package_resolver

pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ dependencies:
1313
collection: ^1.2.0
1414
html: '>=0.12.1 <0.14.0'
1515
logging: '>=0.9.0 <0.12.0'
16-
markdown: ^0.10.1
16+
markdown: ^0.11.0
1717
mustache4dart: ^1.0.9
1818
package_config: '>=0.1.5 <2.0.0'
1919
path: ^1.3.0

testing/test_package_docs/ex/Apple/operator_equals.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,12 +121,12 @@ <h5><a href="ex/Apple-class.html">Apple</a></h5>
121121
a class. The overriding method must still be an equivalence relation.
122122
That is, it must be:</p><ul><li>
123123
<p>Total: It must return a boolean for all arguments. It should never throw
124-
or return <code>null</code>.</p></li><li>
124+
or return <code>null</code>.</p></li><li>
125125
<p>Reflexive: For all objects <code>o</code>, <code>o == o</code> must be true.</p></li><li>
126126
<p>Symmetric: For all objects <code>o1</code> and <code>o2</code>, <code>o1 == o2</code> and <code>o2 == o1</code> must
127-
either both be true, or both be false.</p></li><li>
127+
either both be true, or both be false.</p></li><li>
128128
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
129-
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
129+
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
130130
<p>The method should also be consistent over time, so equality of two objects
131131
should not change over time, or at least only change if one of the objects
132132
was modified.</p>

testing/test_package_docs/ex/B/operator_equals.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,12 +122,12 @@ <h5><a href="ex/B-class.html">B</a></h5>
122122
a class. The overriding method must still be an equivalence relation.
123123
That is, it must be:</p><ul><li>
124124
<p>Total: It must return a boolean for all arguments. It should never throw
125-
or return <code>null</code>.</p></li><li>
125+
or return <code>null</code>.</p></li><li>
126126
<p>Reflexive: For all objects <code>o</code>, <code>o == o</code> must be true.</p></li><li>
127127
<p>Symmetric: For all objects <code>o1</code> and <code>o2</code>, <code>o1 == o2</code> and <code>o2 == o1</code> must
128-
either both be true, or both be false.</p></li><li>
128+
either both be true, or both be false.</p></li><li>
129129
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
130-
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
130+
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
131131
<p>The method should also be consistent over time, so equality of two objects
132132
should not change over time, or at least only change if one of the objects
133133
was modified.</p>

testing/test_package_docs/ex/Cat/operator_equals.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,12 +110,12 @@ <h5><a href="ex/Cat-class.html">Cat</a></h5>
110110
a class. The overriding method must still be an equivalence relation.
111111
That is, it must be:</p><ul><li>
112112
<p>Total: It must return a boolean for all arguments. It should never throw
113-
or return <code>null</code>.</p></li><li>
113+
or return <code>null</code>.</p></li><li>
114114
<p>Reflexive: For all objects <code>o</code>, <code>o == o</code> must be true.</p></li><li>
115115
<p>Symmetric: For all objects <code>o1</code> and <code>o2</code>, <code>o1 == o2</code> and <code>o2 == o1</code> must
116-
either both be true, or both be false.</p></li><li>
116+
either both be true, or both be false.</p></li><li>
117117
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
118-
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
118+
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
119119
<p>The method should also be consistent over time, so equality of two objects
120120
should not change over time, or at least only change if one of the objects
121121
was modified.</p>

testing/test_package_docs/ex/CatString/operator_equals.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,12 @@ <h5><a href="ex/CatString-class.html">CatString</a></h5>
116116
a class. The overriding method must still be an equivalence relation.
117117
That is, it must be:</p><ul><li>
118118
<p>Total: It must return a boolean for all arguments. It should never throw
119-
or return <code>null</code>.</p></li><li>
119+
or return <code>null</code>.</p></li><li>
120120
<p>Reflexive: For all objects <code>o</code>, <code>o == o</code> must be true.</p></li><li>
121121
<p>Symmetric: For all objects <code>o1</code> and <code>o2</code>, <code>o1 == o2</code> and <code>o2 == o1</code> must
122-
either both be true, or both be false.</p></li><li>
122+
either both be true, or both be false.</p></li><li>
123123
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
124-
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
124+
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
125125
<p>The method should also be consistent over time, so equality of two objects
126126
should not change over time, or at least only change if one of the objects
127127
was modified.</p>

testing/test_package_docs/ex/ConstantCat/operator_equals.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,12 +111,12 @@ <h5><a href="ex/ConstantCat-class.html">ConstantCat</a></h5>
111111
a class. The overriding method must still be an equivalence relation.
112112
That is, it must be:</p><ul><li>
113113
<p>Total: It must return a boolean for all arguments. It should never throw
114-
or return <code>null</code>.</p></li><li>
114+
or return <code>null</code>.</p></li><li>
115115
<p>Reflexive: For all objects <code>o</code>, <code>o == o</code> must be true.</p></li><li>
116116
<p>Symmetric: For all objects <code>o1</code> and <code>o2</code>, <code>o1 == o2</code> and <code>o2 == o1</code> must
117-
either both be true, or both be false.</p></li><li>
117+
either both be true, or both be false.</p></li><li>
118118
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
119-
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
119+
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
120120
<p>The method should also be consistent over time, so equality of two objects
121121
should not change over time, or at least only change if one of the objects
122122
was modified.</p>

testing/test_package_docs/ex/Cool/operator_equals.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,12 @@ <h5><a href="ex/Cool-class.html">Cool</a></h5>
109109
a class. The overriding method must still be an equivalence relation.
110110
That is, it must be:</p><ul><li>
111111
<p>Total: It must return a boolean for all arguments. It should never throw
112-
or return <code>null</code>.</p></li><li>
112+
or return <code>null</code>.</p></li><li>
113113
<p>Reflexive: For all objects <code>o</code>, <code>o == o</code> must be true.</p></li><li>
114114
<p>Symmetric: For all objects <code>o1</code> and <code>o2</code>, <code>o1 == o2</code> and <code>o2 == o1</code> must
115-
either both be true, or both be false.</p></li><li>
115+
either both be true, or both be false.</p></li><li>
116116
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
117-
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
117+
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
118118
<p>The method should also be consistent over time, so equality of two objects
119119
should not change over time, or at least only change if one of the objects
120120
was modified.</p>

testing/test_package_docs/ex/Deprecated-class.html

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -153,13 +153,9 @@ <h5><a href="ex/ex-library.html">ex</a></h5>
153153
constructors, whether static or not), named optional arguments and
154154
trailing optional positional parameters.</p>
155155
<p>Deprecation is transitive:</p><ul><li>If a library is deprecated, so is every member of it.</li><li>If a class is deprecated, so is every member of it.</li><li>If a variable is deprecated, so are its implicit getter and setter.</li></ul>
156-
<p>A tool that processes Dart source code may report when:</p><ul><li>the code imports a deprecated library.</li><li>
157-
<p>the code exports a deprecated library, or any deprecated member of
158-
&nbsp;a non-deprecated library.</p></li><li>the code refers statically to a deprecated declaration.</li><li>
159-
<p>the code dynamically uses a member of an object with a statically known
160-
type, where the member is deprecated on the static type of the object.</p></li><li>
161-
<p>the code dynamically calls a method with an argument where the
162-
corresponding optional parameter is deprecated on the object's static type.</p></li></ul>
156+
<p>A tool that processes Dart source code may report when:</p><ul><li>the code imports a deprecated library.</li><li>the code exports a deprecated library, or any deprecated member of &nbsp;a non-deprecated library.</li><li>the code refers statically to a deprecated declaration.</li><li>the code dynamically uses a member of an object with a statically known
157+
type, where the member is deprecated on the static type of the object.</li><li>the code dynamically calls a method with an argument where the
158+
corresponding optional parameter is deprecated on the object's static type.</li></ul>
163159
<p>If the deprecated use is inside a library, class or method which is itself
164160
deprecated, the tool should not bother the user about it.
165161
A deprecated feature is expected to use other deprecated features.</p>

testing/test_package_docs/ex/Deprecated/operator_equals.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,12 @@ <h5><a href="ex/Deprecated-class.html">Deprecated</a></h5>
109109
a class. The overriding method must still be an equivalence relation.
110110
That is, it must be:</p><ul><li>
111111
<p>Total: It must return a boolean for all arguments. It should never throw
112-
or return <code>null</code>.</p></li><li>
112+
or return <code>null</code>.</p></li><li>
113113
<p>Reflexive: For all objects <code>o</code>, <code>o == o</code> must be true.</p></li><li>
114114
<p>Symmetric: For all objects <code>o1</code> and <code>o2</code>, <code>o1 == o2</code> and <code>o2 == o1</code> must
115-
either both be true, or both be false.</p></li><li>
115+
either both be true, or both be false.</p></li><li>
116116
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
117-
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
117+
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
118118
<p>The method should also be consistent over time, so equality of two objects
119119
should not change over time, or at least only change if one of the objects
120120
was modified.</p>

testing/test_package_docs/ex/Dog/operator_equals.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,12 +121,12 @@ <h5><a href="ex/Dog-class.html">Dog</a></h5>
121121
a class. The overriding method must still be an equivalence relation.
122122
That is, it must be:</p><ul><li>
123123
<p>Total: It must return a boolean for all arguments. It should never throw
124-
or return <code>null</code>.</p></li><li>
124+
or return <code>null</code>.</p></li><li>
125125
<p>Reflexive: For all objects <code>o</code>, <code>o == o</code> must be true.</p></li><li>
126126
<p>Symmetric: For all objects <code>o1</code> and <code>o2</code>, <code>o1 == o2</code> and <code>o2 == o1</code> must
127-
either both be true, or both be false.</p></li><li>
127+
either both be true, or both be false.</p></li><li>
128128
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
129-
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
129+
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
130130
<p>The method should also be consistent over time, so equality of two objects
131131
should not change over time, or at least only change if one of the objects
132132
was modified.</p>

testing/test_package_docs/ex/E/operator_equals.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,12 +108,12 @@ <h5><a href="ex/E-class.html">E</a></h5>
108108
a class. The overriding method must still be an equivalence relation.
109109
That is, it must be:</p><ul><li>
110110
<p>Total: It must return a boolean for all arguments. It should never throw
111-
or return <code>null</code>.</p></li><li>
111+
or return <code>null</code>.</p></li><li>
112112
<p>Reflexive: For all objects <code>o</code>, <code>o == o</code> must be true.</p></li><li>
113113
<p>Symmetric: For all objects <code>o1</code> and <code>o2</code>, <code>o1 == o2</code> and <code>o2 == o1</code> must
114-
either both be true, or both be false.</p></li><li>
114+
either both be true, or both be false.</p></li><li>
115115
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
116-
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
116+
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
117117
<p>The method should also be consistent over time, so equality of two objects
118118
should not change over time, or at least only change if one of the objects
119119
was modified.</p>

testing/test_package_docs/ex/ForAnnotation/operator_equals.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,12 @@ <h5><a href="ex/ForAnnotation-class.html">ForAnnotation</a></h5>
109109
a class. The overriding method must still be an equivalence relation.
110110
That is, it must be:</p><ul><li>
111111
<p>Total: It must return a boolean for all arguments. It should never throw
112-
or return <code>null</code>.</p></li><li>
112+
or return <code>null</code>.</p></li><li>
113113
<p>Reflexive: For all objects <code>o</code>, <code>o == o</code> must be true.</p></li><li>
114114
<p>Symmetric: For all objects <code>o1</code> and <code>o2</code>, <code>o1 == o2</code> and <code>o2 == o1</code> must
115-
either both be true, or both be false.</p></li><li>
115+
either both be true, or both be false.</p></li><li>
116116
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
117-
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
117+
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
118118
<p>The method should also be consistent over time, so equality of two objects
119119
should not change over time, or at least only change if one of the objects
120120
was modified.</p>

testing/test_package_docs/ex/HasAnnotation/operator_equals.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,12 +108,12 @@ <h5><a href="ex/HasAnnotation-class.html">HasAnnotation</a></h5>
108108
a class. The overriding method must still be an equivalence relation.
109109
That is, it must be:</p><ul><li>
110110
<p>Total: It must return a boolean for all arguments. It should never throw
111-
or return <code>null</code>.</p></li><li>
111+
or return <code>null</code>.</p></li><li>
112112
<p>Reflexive: For all objects <code>o</code>, <code>o == o</code> must be true.</p></li><li>
113113
<p>Symmetric: For all objects <code>o1</code> and <code>o2</code>, <code>o1 == o2</code> and <code>o2 == o1</code> must
114-
either both be true, or both be false.</p></li><li>
114+
either both be true, or both be false.</p></li><li>
115115
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
116-
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
116+
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
117117
<p>The method should also be consistent over time, so equality of two objects
118118
should not change over time, or at least only change if one of the objects
119119
was modified.</p>

testing/test_package_docs/ex/Helper/operator_equals.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,12 @@ <h5><a href="ex/Helper-class.html">Helper</a></h5>
109109
a class. The overriding method must still be an equivalence relation.
110110
That is, it must be:</p><ul><li>
111111
<p>Total: It must return a boolean for all arguments. It should never throw
112-
or return <code>null</code>.</p></li><li>
112+
or return <code>null</code>.</p></li><li>
113113
<p>Reflexive: For all objects <code>o</code>, <code>o == o</code> must be true.</p></li><li>
114114
<p>Symmetric: For all objects <code>o1</code> and <code>o2</code>, <code>o1 == o2</code> and <code>o2 == o1</code> must
115-
either both be true, or both be false.</p></li><li>
115+
either both be true, or both be false.</p></li><li>
116116
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
117-
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
117+
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
118118
<p>The method should also be consistent over time, so equality of two objects
119119
should not change over time, or at least only change if one of the objects
120120
was modified.</p>

testing/test_package_docs/ex/Klass/operator_equals.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,12 +110,12 @@ <h5><a href="ex/Klass-class.html">Klass</a></h5>
110110
a class. The overriding method must still be an equivalence relation.
111111
That is, it must be:</p><ul><li>
112112
<p>Total: It must return a boolean for all arguments. It should never throw
113-
or return <code>null</code>.</p></li><li>
113+
or return <code>null</code>.</p></li><li>
114114
<p>Reflexive: For all objects <code>o</code>, <code>o == o</code> must be true.</p></li><li>
115115
<p>Symmetric: For all objects <code>o1</code> and <code>o2</code>, <code>o1 == o2</code> and <code>o2 == o1</code> must
116-
either both be true, or both be false.</p></li><li>
116+
either both be true, or both be false.</p></li><li>
117117
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
118-
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
118+
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
119119
<p>The method should also be consistent over time, so equality of two objects
120120
should not change over time, or at least only change if one of the objects
121121
was modified.</p>

testing/test_package_docs/ex/MyError/operator_equals.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,12 @@ <h5><a href="ex/MyError-class.html">MyError</a></h5>
109109
a class. The overriding method must still be an equivalence relation.
110110
That is, it must be:</p><ul><li>
111111
<p>Total: It must return a boolean for all arguments. It should never throw
112-
or return <code>null</code>.</p></li><li>
112+
or return <code>null</code>.</p></li><li>
113113
<p>Reflexive: For all objects <code>o</code>, <code>o == o</code> must be true.</p></li><li>
114114
<p>Symmetric: For all objects <code>o1</code> and <code>o2</code>, <code>o1 == o2</code> and <code>o2 == o1</code> must
115-
either both be true, or both be false.</p></li><li>
115+
either both be true, or both be false.</p></li><li>
116116
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
117-
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
117+
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
118118
<p>The method should also be consistent over time, so equality of two objects
119119
should not change over time, or at least only change if one of the objects
120120
was modified.</p>

testing/test_package_docs/ex/MyErrorImplements/operator_equals.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,12 @@ <h5><a href="ex/MyErrorImplements-class.html">MyErrorImplements</a></h5>
109109
a class. The overriding method must still be an equivalence relation.
110110
That is, it must be:</p><ul><li>
111111
<p>Total: It must return a boolean for all arguments. It should never throw
112-
or return <code>null</code>.</p></li><li>
112+
or return <code>null</code>.</p></li><li>
113113
<p>Reflexive: For all objects <code>o</code>, <code>o == o</code> must be true.</p></li><li>
114114
<p>Symmetric: For all objects <code>o1</code> and <code>o2</code>, <code>o1 == o2</code> and <code>o2 == o1</code> must
115-
either both be true, or both be false.</p></li><li>
115+
either both be true, or both be false.</p></li><li>
116116
<p>Transitive: For all objects <code>o1</code>, <code>o2</code>, and <code>o3</code>, if <code>o1 == o2</code> and
117-
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
117+
<code>o2 == o3</code> are true, then <code>o1 == o3</code> must be true.</p></li></ul>
118118
<p>The method should also be consistent over time, so equality of two objects
119119
should not change over time, or at least only change if one of the objects
120120
was modified.</p>

0 commit comments

Comments
 (0)