Skip to content

Commit 45b4a62

Browse files
re-generate docs
Co-Authored-By: Luke Wagner <[email protected]>
1 parent c170ea0 commit 45b4a62

File tree

2 files changed

+34
-34
lines changed

2 files changed

+34
-34
lines changed

imports.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -751,7 +751,7 @@ resource for the purposes of equality checking.</p>
751751
<h4><a id="field_name"></a><code>type field-name</code></h4>
752752
<p><a href="#field_key"><a href="#field_key"><code>field-key</code></a></a></p>
753753
<p>Field names are always strings.
754-
<p>Field keys should always be treated as case insensitive by the <a href="#fields"><code>fields</code></a>
754+
<p>Field names should always be treated as case insensitive by the <a href="#fields"><code>fields</code></a>
755755
resource for the purposes of equality checking.</p>
756756
<h4><a id="field_value"></a><code>type field-value</code></h4>
757757
<p><a href="#field_value"><a href="#field_value"><code>field-value</code></a></a></p>
@@ -858,10 +858,10 @@ http-related errors.</p>
858858
<h4><a id="static_fields_from_list"></a><code>[static]fields.from-list: func</code></h4>
859859
<p>Construct an HTTP Fields.</p>
860860
<p>The resulting <a href="#fields"><code>fields</code></a> is mutable.</p>
861-
<p>The list represents each key-value pair in the Fields. Keys
861+
<p>The list represents each name-value pair in the Fields. Names
862862
which have multiple values are represented by multiple entries in this
863-
list with the same key.</p>
864-
<p>The tuple is a pair of the field key, represented as a string, and
863+
list with the same name.</p>
864+
<p>The tuple is a pair of the field name, represented as a string, and
865865
Value, represented as a list of bytes.</p>
866866
<p>An error result will be returned if any <a href="#field_name"><code>field-name</code></a> or <a href="#field_value"><code>field-value</code></a> is
867867
syntactically invalid, or if a field is forbidden.</p>
@@ -874,9 +874,9 @@ syntactically invalid, or if a field is forbidden.</p>
874874
<li><a id="static_fields_from_list.0"></a> result&lt;own&lt;<a href="#fields"><a href="#fields"><code>fields</code></a></a>&gt;, <a href="#header_error"><a href="#header_error"><code>header-error</code></a></a>&gt;</li>
875875
</ul>
876876
<h4><a id="method_fields_get"></a><code>[method]fields.get: func</code></h4>
877-
<p>Get all of the values corresponding to a key. If the key is not present
877+
<p>Get all of the values corresponding to a name. If the name is not present
878878
in this <a href="#fields"><code>fields</code></a> or is syntactically invalid, an empty list is returned.
879-
However, if the key is present but empty, this is represented by a list
879+
However, if the name is present but empty, this is represented by a list
880880
with one or more empty field-values present.</p>
881881
<h5>Params</h5>
882882
<ul>
@@ -888,7 +888,7 @@ with one or more empty field-values present.</p>
888888
<li><a id="method_fields_get.0"></a> list&lt;<a href="#field_value"><a href="#field_value"><code>field-value</code></a></a>&gt;</li>
889889
</ul>
890890
<h4><a id="method_fields_has"></a><code>[method]fields.has: func</code></h4>
891-
<p>Returns <code>true</code> when the key is present in this <a href="#fields"><code>fields</code></a>. If the key is
891+
<p>Returns <code>true</code> when the name is present in this <a href="#fields"><code>fields</code></a>. If the name is
892892
syntactically invalid, <code>false</code> is returned.</p>
893893
<h5>Params</h5>
894894
<ul>
@@ -900,8 +900,8 @@ syntactically invalid, <code>false</code> is returned.</p>
900900
<li><a id="method_fields_has.0"></a> <code>bool</code></li>
901901
</ul>
902902
<h4><a id="method_fields_set"></a><code>[method]fields.set: func</code></h4>
903-
<p>Set all of the values for a key. Clears any existing values for that
904-
key, if they have been set.</p>
903+
<p>Set all of the values for a name. Clears any existing values for that
904+
name, if they have been set.</p>
905905
<p>Fails with <code>header-error.immutable</code> if the <a href="#fields"><code>fields</code></a> are immutable.</p>
906906
<p>Fails with <code>header-error.invalid-syntax</code> if the <a href="#field_name"><code>field-name</code></a> or any of
907907
the <a href="#field_value"><code>field-value</code></a>s are syntactically invalid.</p>
@@ -916,7 +916,7 @@ the <a href="#field_value"><code>field-value</code></a>s are syntactically inval
916916
<li><a id="method_fields_set.0"></a> result&lt;_, <a href="#header_error"><a href="#header_error"><code>header-error</code></a></a>&gt;</li>
917917
</ul>
918918
<h4><a id="method_fields_delete"></a><code>[method]fields.delete: func</code></h4>
919-
<p>Delete all values for a key. Does nothing if no values for the key
919+
<p>Delete all values for a name. Does nothing if no values for the name
920920
exist.</p>
921921
<p>Fails with <code>header-error.immutable</code> if the <a href="#fields"><code>fields</code></a> are immutable.</p>
922922
<p>Fails with <code>header-error.invalid-syntax</code> if the <a href="#field_name"><code>field-name</code></a> is
@@ -931,8 +931,8 @@ syntactically invalid.</p>
931931
<li><a id="method_fields_delete.0"></a> result&lt;_, <a href="#header_error"><a href="#header_error"><code>header-error</code></a></a>&gt;</li>
932932
</ul>
933933
<h4><a id="method_fields_append"></a><code>[method]fields.append: func</code></h4>
934-
<p>Append a value for a key. Does not change or delete any existing
935-
values for that key.</p>
934+
<p>Append a value for a name. Does not change or delete any existing
935+
values for that name.</p>
936936
<p>Fails with <code>header-error.immutable</code> if the <a href="#fields"><code>fields</code></a> are immutable.</p>
937937
<p>Fails with <code>header-error.invalid-syntax</code> if the <a href="#field_name"><code>field-name</code></a> or
938938
<a href="#field_value"><code>field-value</code></a> are syntactically invalid.</p>
@@ -947,12 +947,12 @@ values for that key.</p>
947947
<li><a id="method_fields_append.0"></a> result&lt;_, <a href="#header_error"><a href="#header_error"><code>header-error</code></a></a>&gt;</li>
948948
</ul>
949949
<h4><a id="method_fields_entries"></a><code>[method]fields.entries: func</code></h4>
950-
<p>Retrieve the full set of keys and values in the Fields. Like the
951-
constructor, the list represents each key-value pair.</p>
952-
<p>The outer list represents each key-value pair in the Fields. Keys
950+
<p>Retrieve the full set of names and values in the Fields. Like the
951+
constructor, the list represents each name-value pair.</p>
952+
<p>The outer list represents each name-value pair in the Fields. Names
953953
which have multiple values are represented by multiple entries in this
954-
list with the same key.</p>
955-
<p>The keys and values are always returned in the original casing and in
954+
list with the same name.</p>
955+
<p>The names and values are always returned in the original casing and in
956956
the order in which they will be serialized for transport.</p>
957957
<h5>Params</h5>
958958
<ul>

proxy.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -645,7 +645,7 @@ resource for the purposes of equality checking.</p>
645645
<h4><a id="field_name"></a><code>type field-name</code></h4>
646646
<p><a href="#field_key"><a href="#field_key"><code>field-key</code></a></a></p>
647647
<p>Field names are always strings.
648-
<p>Field keys should always be treated as case insensitive by the <a href="#fields"><code>fields</code></a>
648+
<p>Field names should always be treated as case insensitive by the <a href="#fields"><code>fields</code></a>
649649
resource for the purposes of equality checking.</p>
650650
<h4><a id="field_value"></a><code>type field-value</code></h4>
651651
<p><a href="#field_value"><a href="#field_value"><code>field-value</code></a></a></p>
@@ -752,10 +752,10 @@ http-related errors.</p>
752752
<h4><a id="static_fields_from_list"></a><code>[static]fields.from-list: func</code></h4>
753753
<p>Construct an HTTP Fields.</p>
754754
<p>The resulting <a href="#fields"><code>fields</code></a> is mutable.</p>
755-
<p>The list represents each key-value pair in the Fields. Keys
755+
<p>The list represents each name-value pair in the Fields. Names
756756
which have multiple values are represented by multiple entries in this
757-
list with the same key.</p>
758-
<p>The tuple is a pair of the field key, represented as a string, and
757+
list with the same name.</p>
758+
<p>The tuple is a pair of the field name, represented as a string, and
759759
Value, represented as a list of bytes.</p>
760760
<p>An error result will be returned if any <a href="#field_name"><code>field-name</code></a> or <a href="#field_value"><code>field-value</code></a> is
761761
syntactically invalid, or if a field is forbidden.</p>
@@ -768,9 +768,9 @@ syntactically invalid, or if a field is forbidden.</p>
768768
<li><a id="static_fields_from_list.0"></a> result&lt;own&lt;<a href="#fields"><a href="#fields"><code>fields</code></a></a>&gt;, <a href="#header_error"><a href="#header_error"><code>header-error</code></a></a>&gt;</li>
769769
</ul>
770770
<h4><a id="method_fields_get"></a><code>[method]fields.get: func</code></h4>
771-
<p>Get all of the values corresponding to a key. If the key is not present
771+
<p>Get all of the values corresponding to a name. If the name is not present
772772
in this <a href="#fields"><code>fields</code></a> or is syntactically invalid, an empty list is returned.
773-
However, if the key is present but empty, this is represented by a list
773+
However, if the name is present but empty, this is represented by a list
774774
with one or more empty field-values present.</p>
775775
<h5>Params</h5>
776776
<ul>
@@ -782,7 +782,7 @@ with one or more empty field-values present.</p>
782782
<li><a id="method_fields_get.0"></a> list&lt;<a href="#field_value"><a href="#field_value"><code>field-value</code></a></a>&gt;</li>
783783
</ul>
784784
<h4><a id="method_fields_has"></a><code>[method]fields.has: func</code></h4>
785-
<p>Returns <code>true</code> when the key is present in this <a href="#fields"><code>fields</code></a>. If the key is
785+
<p>Returns <code>true</code> when the name is present in this <a href="#fields"><code>fields</code></a>. If the name is
786786
syntactically invalid, <code>false</code> is returned.</p>
787787
<h5>Params</h5>
788788
<ul>
@@ -794,8 +794,8 @@ syntactically invalid, <code>false</code> is returned.</p>
794794
<li><a id="method_fields_has.0"></a> <code>bool</code></li>
795795
</ul>
796796
<h4><a id="method_fields_set"></a><code>[method]fields.set: func</code></h4>
797-
<p>Set all of the values for a key. Clears any existing values for that
798-
key, if they have been set.</p>
797+
<p>Set all of the values for a name. Clears any existing values for that
798+
name, if they have been set.</p>
799799
<p>Fails with <code>header-error.immutable</code> if the <a href="#fields"><code>fields</code></a> are immutable.</p>
800800
<p>Fails with <code>header-error.invalid-syntax</code> if the <a href="#field_name"><code>field-name</code></a> or any of
801801
the <a href="#field_value"><code>field-value</code></a>s are syntactically invalid.</p>
@@ -810,7 +810,7 @@ the <a href="#field_value"><code>field-value</code></a>s are syntactically inval
810810
<li><a id="method_fields_set.0"></a> result&lt;_, <a href="#header_error"><a href="#header_error"><code>header-error</code></a></a>&gt;</li>
811811
</ul>
812812
<h4><a id="method_fields_delete"></a><code>[method]fields.delete: func</code></h4>
813-
<p>Delete all values for a key. Does nothing if no values for the key
813+
<p>Delete all values for a name. Does nothing if no values for the name
814814
exist.</p>
815815
<p>Fails with <code>header-error.immutable</code> if the <a href="#fields"><code>fields</code></a> are immutable.</p>
816816
<p>Fails with <code>header-error.invalid-syntax</code> if the <a href="#field_name"><code>field-name</code></a> is
@@ -825,8 +825,8 @@ syntactically invalid.</p>
825825
<li><a id="method_fields_delete.0"></a> result&lt;_, <a href="#header_error"><a href="#header_error"><code>header-error</code></a></a>&gt;</li>
826826
</ul>
827827
<h4><a id="method_fields_append"></a><code>[method]fields.append: func</code></h4>
828-
<p>Append a value for a key. Does not change or delete any existing
829-
values for that key.</p>
828+
<p>Append a value for a name. Does not change or delete any existing
829+
values for that name.</p>
830830
<p>Fails with <code>header-error.immutable</code> if the <a href="#fields"><code>fields</code></a> are immutable.</p>
831831
<p>Fails with <code>header-error.invalid-syntax</code> if the <a href="#field_name"><code>field-name</code></a> or
832832
<a href="#field_value"><code>field-value</code></a> are syntactically invalid.</p>
@@ -841,12 +841,12 @@ values for that key.</p>
841841
<li><a id="method_fields_append.0"></a> result&lt;_, <a href="#header_error"><a href="#header_error"><code>header-error</code></a></a>&gt;</li>
842842
</ul>
843843
<h4><a id="method_fields_entries"></a><code>[method]fields.entries: func</code></h4>
844-
<p>Retrieve the full set of keys and values in the Fields. Like the
845-
constructor, the list represents each key-value pair.</p>
846-
<p>The outer list represents each key-value pair in the Fields. Keys
844+
<p>Retrieve the full set of names and values in the Fields. Like the
845+
constructor, the list represents each name-value pair.</p>
846+
<p>The outer list represents each name-value pair in the Fields. Names
847847
which have multiple values are represented by multiple entries in this
848-
list with the same key.</p>
849-
<p>The keys and values are always returned in the original casing and in
848+
list with the same name.</p>
849+
<p>The names and values are always returned in the original casing and in
850850
the order in which they will be serialized for transport.</p>
851851
<h5>Params</h5>
852852
<ul>

0 commit comments

Comments
 (0)