Skip to content

Commit 6b10456

Browse files
amanda-tarafaamanda-tarafa
authored
fix(sidekick): Remove double sample code blocks (#2582)
1 parent 3b308e7 commit 6b10456

File tree

10 files changed

+37
-203
lines changed

10 files changed

+37
-203
lines changed

‎internal/sidekick/internal/rust/templates/common/message.mustache‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ impl {{Codec.Name}} {
155155
})
156156
}
157157

158-
{{> /templates/common/oneof_variants}}
158+
{{> /templates/common/setter_preamble/oneof_variants}}
159159
{{#Singular}}
160160
pub fn set_{{Codec.SetterName}}<T: std::convert::Into<{{{Codec.FieldType}}}>>(mut self, v: T) -> Self {
161161
self.{{Group.Codec.FieldName}} = std::option::Option::Some(

‎internal/sidekick/internal/rust/templates/common/setter_preamble/map.mustache‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,13 @@ See the License for the specific language governing permissions and
1414
limitations under the License.
1515
}}
1616
/// Sets the value of [{{Codec.FieldName}}][{{Codec.FQMessageName}}::{{Codec.SetterName}}].
17+
{{#ModelCodec.GenerateSetterSamples}}
18+
///
19+
/// # Example
20+
/// ```
1721
{{> /templates/common/setter_preamble/map_samples}}
22+
/// ```
23+
{{/ModelCodec.GenerateSetterSamples}}
1824
{{#Deprecated}}
1925
#[deprecated]
2026
{{/Deprecated}}

‎internal/sidekick/internal/rust/templates/common/setter_preamble/map_samples.mustache‎

Lines changed: 0 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -13,251 +13,165 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1313
See the License for the specific language governing permissions and
1414
limitations under the License.
1515
}}
16-
{{#ModelCodec.GenerateSetterSamples}}
1716
{{#Codec.KeyField.IsString}}
1817
{{#Codec.ValueField.IsString}}
19-
///
20-
/// # Example
21-
/// ```
2218
/// # use {{Parent.Codec.NameInExamples}};
2319
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
2420
/// ("key0", "abc"),
2521
/// ("key1", "xyz"),
2622
/// ]);
27-
/// ```
2823
{{/Codec.ValueField.IsString}}
2924
{{#Codec.ValueField.IsBytes}}
30-
///
31-
/// # Example
32-
/// ```
3325
/// # use {{Parent.Codec.NameInExamples}};
3426
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
3527
/// ("key0", bytes::Bytes::from_static(b"abc")),
3628
/// ("key1", bytes::Bytes::from_static(b"xyz")),
3729
/// ]);
38-
/// ```
3930
{{/Codec.ValueField.IsBytes}}
4031
{{#Codec.ValueField.IsBool}}
41-
///
42-
/// # Example
43-
/// ```
4432
/// # use {{Parent.Codec.NameInExamples}};
4533
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
4634
/// ("key0", true),
4735
/// ("key1", false),
4836
/// ]);
49-
/// ```
5037
{{/Codec.ValueField.IsBool}}
5138
{{#Codec.ValueField.IsLikeInt}}
52-
///
53-
/// # Example
54-
/// ```
5539
/// # use {{Parent.Codec.NameInExamples}};
5640
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
5741
/// ("key0", 123),
5842
/// ("key1", 456),
5943
/// ]);
60-
/// ```
6144
{{/Codec.ValueField.IsLikeInt}}
6245
{{#Codec.ValueField.IsLikeFloat}}
63-
///
64-
/// # Example
65-
/// ```
6646
/// # use {{Parent.Codec.NameInExamples}};
6747
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
6848
/// ("key0", 123.5),
6949
/// ("key1", 456.5),
7050
/// ]);
71-
/// ```
7251
{{/Codec.ValueField.IsLikeFloat}}
7352
{{#Codec.ValueField.IsEnum}}
74-
///
75-
/// # Example
76-
/// ```
7753
/// # use {{Parent.Codec.NameInExamples}};
7854
/// use {{Codec.ValueField.EnumType.Codec.NameInExamples}};
7955
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
8056
{{#Codec.ValueField.EnumType.Codec.ValuesForExamples}}
8157
/// ("key{{Index}}", {{EnumValue.Codec.EnumType}}::{{EnumValue.Codec.VariantName}}),
8258
{{/Codec.ValueField.EnumType.Codec.ValuesForExamples}}
8359
/// ]);
84-
/// ```
8560
{{/Codec.ValueField.IsEnum}}
8661
{{#Codec.ValueField.IsObject}}
87-
///
88-
/// # Example
89-
/// ```
9062
/// # use {{Parent.Codec.NameInExamples}};
9163
/// use {{Codec.ValueField.MessageType.Codec.NameInExamples}};
9264
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
9365
/// ("key0", {{Codec.ValueField.MessageType.Codec.Name}}::default()/* use setters */),
9466
/// ("key1", {{Codec.ValueField.MessageType.Codec.Name}}::default()/* use (different) setters */),
9567
/// ]);
96-
/// ```
9768
{{/Codec.ValueField.IsObject}}
9869
{{/Codec.KeyField.IsString}}
9970
{{#Codec.KeyField.IsBool}}
10071
{{#Codec.ValueField.IsString}}
101-
///
102-
/// # Example
103-
/// ```
10472
/// # use {{Parent.Codec.NameInExamples}};
10573
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
10674
/// (true, "abc"),
10775
/// (false, "xyz"),
10876
/// ]);
109-
/// ```
11077
{{/Codec.ValueField.IsString}}
11178
{{#Codec.ValueField.IsBytes}}
112-
///
113-
/// # Example
114-
/// ```
11579
/// # use {{Parent.Codec.NameInExamples}};
11680
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
11781
/// (true, bytes::Bytes::from_static(b"abc")),
11882
/// (false, bytes::Bytes::from_static(b"xyz")),
11983
/// ]);
120-
/// ```
12184
{{/Codec.ValueField.IsBytes}}
12285
{{#Codec.ValueField.IsBool}}
123-
///
124-
/// # Example
125-
/// ```
12686
/// # use {{Parent.Codec.NameInExamples}};
12787
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
12888
/// (true, true),
12989
/// (false, false),
13090
/// ]);
131-
/// ```
13291
{{/Codec.ValueField.IsBool}}
13392
{{#Codec.ValueField.IsLikeInt}}
134-
///
135-
/// # Example
136-
/// ```
13793
/// # use {{Parent.Codec.NameInExamples}};
13894
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
13995
/// (true, 123),
14096
/// (false, 456),
14197
/// ]);
142-
/// ```
14398
{{/Codec.ValueField.IsLikeInt}}
14499
{{#Codec.ValueField.IsLikeFloat}}
145-
///
146-
/// # Example
147-
/// ```
148100
/// # use {{Parent.Codec.NameInExamples}};
149101
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
150102
/// (true, 123.5),
151103
/// (false, 456.5),
152104
/// ]);
153-
/// ```
154105
{{/Codec.ValueField.IsLikeFloat}}
155106
{{#Codec.ValueField.IsEnum}}
156-
///
157-
/// # Example
158-
/// ```
159107
/// # use {{Parent.Codec.NameInExamples}};
160108
/// use {{Codec.ValueField.EnumType.Codec.NameInExamples}};
161109
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
162110
{{#Codec.ValueField.EnumType.Codec.ValuesForExamples}}
163111
/// (true, {{EnumValue.Codec.EnumType}}::{{EnumValue.Codec.VariantName}}),
164112
{{/Codec.ValueField.EnumType.Codec.ValuesForExamples}}
165113
/// ]);
166-
/// ```
167114
{{/Codec.ValueField.IsEnum}}
168115
{{#Codec.ValueField.IsObject}}
169-
///
170-
/// # Example
171-
/// ```
172116
/// # use {{Parent.Codec.NameInExamples}};
173117
/// use {{Codec.ValueField.MessageType.Codec.NameInExamples}};
174118
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
175119
/// (true, {{Codec.ValueField.MessageType.Codec.Name}}::default()/* use setters */),
176120
/// (false, {{Codec.ValueField.MessageType.Codec.Name}}::default()/* use (different) setters */),
177121
/// ]);
178-
/// ```
179122
{{/Codec.ValueField.IsObject}}
180123
{{/Codec.KeyField.IsBool}}
181124
{{#Codec.KeyField.IsLikeInt}}
182125
{{#Codec.ValueField.IsString}}
183-
///
184-
/// # Example
185-
/// ```
186126
/// # use {{Parent.Codec.NameInExamples}};
187127
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
188128
/// (0, "abc"),
189129
/// (1, "xyz"),
190130
/// ]);
191-
/// ```
192131
{{/Codec.ValueField.IsString}}
193132
{{#Codec.ValueField.IsBytes}}
194-
///
195-
/// # Example
196-
/// ```
197133
/// # use {{Parent.Codec.NameInExamples}};
198134
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
199135
/// (0, bytes::Bytes::from_static(b"abc")),
200136
/// (1, bytes::Bytes::from_static(b"xyz")),
201137
/// ]);
202-
/// ```
203138
{{/Codec.ValueField.IsBytes}}
204139
{{#Codec.ValueField.IsBool}}
205-
///
206-
/// # Example
207-
/// ```
208140
/// # use {{Parent.Codec.NameInExamples}};
209141
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
210142
/// (0, true),
211143
/// (1, false),
212144
/// ]);
213-
/// ```
214145
{{/Codec.ValueField.IsBool}}
215146
{{#Codec.ValueField.IsLikeInt}}
216-
///
217-
/// # Example
218-
/// ```
219147
/// # use {{Parent.Codec.NameInExamples}};
220148
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
221149
/// (0, 123),
222150
/// (1, 456),
223151
/// ]);
224-
/// ```
225152
{{/Codec.ValueField.IsLikeInt}}
226153
{{#Codec.ValueField.IsLikeFloat}}
227-
///
228-
/// # Example
229-
/// ```
230154
/// # use {{Parent.Codec.NameInExamples}};
231155
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
232156
/// (0, 123.5),
233157
/// (1, 456.5),
234158
/// ]);
235-
/// ```
236159
{{/Codec.ValueField.IsLikeFloat}}
237160
{{#Codec.ValueField.IsEnum}}
238-
///
239-
/// # Example
240-
/// ```
241161
/// # use {{Parent.Codec.NameInExamples}};
242162
/// use {{Codec.ValueField.EnumType.Codec.NameInExamples}};
243163
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
244164
{{#Codec.ValueField.EnumType.Codec.ValuesForExamples}}
245165
/// ({{Index}}, {{EnumValue.Codec.EnumType}}::{{EnumValue.Codec.VariantName}}),
246166
{{/Codec.ValueField.EnumType.Codec.ValuesForExamples}}
247167
/// ]);
248-
/// ```
249168
{{/Codec.ValueField.IsEnum}}
250169
{{#Codec.ValueField.IsObject}}
251-
///
252-
/// # Example
253-
/// ```
254170
/// # use {{Parent.Codec.NameInExamples}};
255171
/// use {{Codec.ValueField.MessageType.Codec.NameInExamples}};
256172
/// let x = {{Parent.Codec.Name}}::new().set_{{Codec.SetterName}}([
257173
/// (0, {{Codec.ValueField.MessageType.Codec.Name}}::default()/* use setters */),
258174
/// (1, {{Codec.ValueField.MessageType.Codec.Name}}::default()/* use (different) setters */),
259175
/// ]);
260-
/// ```
261176
{{/Codec.ValueField.IsObject}}
262177
{{/Codec.KeyField.IsLikeInt}}
263-
{{/ModelCodec.GenerateSetterSamples}}

‎internal/sidekick/internal/rust/templates/common/setter_preamble/oneof.mustache‎

Lines changed: 12 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -18,50 +18,34 @@ limitations under the License.
1818
/// Note that all the setters affecting `{{Codec.FieldName}}` are mutually
1919
/// exclusive.
2020
{{#ModelCodec.GenerateSetterSamples}}
21-
{{#Codec.ExampleField}}
22-
{{#IsString}}
2321
///
2422
/// # Example
2523
/// ```
24+
{{#Codec.ExampleField}}
25+
{{#IsString}}
2626
/// # use {{Parent.Codec.NameInExamples}};
2727
/// let x = {{Parent.Codec.Name}}::new().set_{{Group.Codec.SetterName}}(Some({{{Group.Codec.RelativeName}}}::{{Codec.BranchName}}("value".to_string())));
28-
/// ```
29-
{{/IsString}}
30-
{{#IsLikeInt}}
31-
///
32-
/// # Example
33-
/// ```
28+
{{/IsString}}
29+
{{#IsLikeInt}}
3430
/// # use {{Parent.Codec.NameInExamples}};
3531
/// let x = {{Parent.Codec.Name}}::new().set_{{Group.Codec.SetterName}}(Some({{{Group.Codec.RelativeName}}}::{{Codec.BranchName}}(123)));
36-
/// ```
37-
{{/IsLikeInt}}
38-
{{#IsObject}}
39-
///
40-
/// # Example
41-
/// ```
32+
{{/IsLikeInt}}
33+
{{#IsObject}}
4234
/// # use {{Parent.Codec.NameInExamples}};
4335
/// use {{MessageType.Codec.NameInExamples}};
4436
/// let x = {{Parent.Codec.Name}}::new().set_{{Group.Codec.SetterName}}(Some({{{Group.Codec.RelativeName}}}::{{Codec.BranchName}}({{MessageType.Codec.Name}}::default()/* use setters */)));
45-
/// ```
46-
{{/IsObject}}
47-
{{#Repeated}}
48-
///
49-
/// # Example
50-
/// ```
37+
{{/IsObject}}
38+
{{#Repeated}}
5139
/// # use {{Parent.Codec.NameInExamples}};
5240
/// use {{MessageType.Codec.NameInExamples}};
5341
/// let x = {{Parent.Codec.Name}}::new().set_{{Group.Codec.SetterName}}(Some({{{Group.Codec.RelativeName}}}::{{Codec.BranchName}}(vec![{{MessageType.Codec.Name}}::default()])));
54-
/// ```
55-
{{/Repeated}}
56-
{{#Map}}
57-
///
58-
/// # Example
59-
/// ```
42+
{{/Repeated}}
43+
{{#Map}}
6044
/// # use {{Parent.Codec.NameInExamples}};
6145
/// use {{KeyField.MessageType.Codec.NameInExamples}};
6246
/// use {{ValueField.MessageType.Codec.NameInExamples}};
6347
/// let x = {{Parent.Codec.Name}}::new().set_{{Group.Codec.SetterName}}(Some({{{Group.Codec.RelativeName}}}::{{Codec.BranchName}}(std::collections::HashMap::from([({{KeyField.MessageType.Codec.Name}}::default(), {{ValueField.MessageType.Codec.Name}}::default())]))));
64-
/// ```
65-
{{/Map}}
48+
{{/Map}}
6649
{{/Codec.ExampleField}}
50+
/// ```
6751
{{/ModelCodec.GenerateSetterSamples}}

internal/sidekick/internal/rust/templates/common/oneof_variants.mustache renamed to internal/sidekick/internal/rust/templates/common/setter_preamble/oneof_variants.mustache

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ limitations under the License.
1818
///
1919
/// Note that all the setters affecting `{{Group.Codec.FieldName}}` are
2020
/// mutually exclusive.
21+
{{#ModelCodec.GenerateSetterSamples}}
22+
///
23+
/// # Example
24+
/// ```
2125
{{#Singular}}
2226
{{> /templates/common/setter_preamble/singular_value_samples}}
2327
{{/Singular}}
@@ -27,8 +31,6 @@ limitations under the License.
2731
{{#Map}}
2832
{{> /templates/common/setter_preamble/map_samples}}
2933
{{/Map}}
30-
{{#ModelCodec.GenerateSetterSamples}}
31-
/// ```
3234
/// assert!(x.{{Codec.FieldName}}().is_some());
3335
{{#Codec.OtherFieldsInGroup}}
3436
/// assert!(x.{{Codec.FieldName}}().is_none());

‎internal/sidekick/internal/rust/templates/common/setter_preamble/repeated.mustache‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,13 @@ See the License for the specific language governing permissions and
1414
limitations under the License.
1515
}}
1616
/// Sets the value of [{{Codec.FieldName}}][{{Codec.FQMessageName}}::{{Codec.SetterName}}].
17+
{{#ModelCodec.GenerateSetterSamples}}
18+
///
19+
/// # Example
20+
/// ```
1721
{{> /templates/common/setter_preamble/repeated_samples}}
22+
/// ```
23+
{{/ModelCodec.GenerateSetterSamples}}
1824
{{#Deprecated}}
1925
#[deprecated]
2026
{{/Deprecated}}

0 commit comments

Comments
 (0)