Skip to content

Commit dbd45a0

Browse files
committed
Rename a couple methods
1 parent 51b2c36 commit dbd45a0

File tree

4 files changed

+7
-5
lines changed

4 files changed

+7
-5
lines changed

aws_doc_sdk_examples_tools/doc_gen.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ def validate(self):
321321
self.root,
322322
)
323323

324-
def fill_fields(self):
324+
def fill_missing_fields(self):
325325
for example in self.examples.values():
326326
service_id = example.service_main or next(
327327
k for (k, _) in example.services.items()
@@ -330,7 +330,9 @@ def fill_fields(self):
330330
next((k for k in example.services[service_id]), None)
331331
or example.id.split("_", 1)[1]
332332
)
333-
example.fill_title(self.categories, self.services[service_id].short, action)
333+
example.fill_display_fields(
334+
self.categories, self.services[service_id].short, action
335+
)
334336

335337
def stats(self):
336338
values = self.examples.values()

aws_doc_sdk_examples_tools/doc_gen_cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ def main():
5454
merged_doc_gen.merge(unmerged_doc_gen)
5555

5656
merged_doc_gen.validate()
57-
merged_doc_gen.fill_fields()
57+
merged_doc_gen.fill_missing_fields()
5858

5959
if not args.skip_entity_expansion:
6060
# Replace entities

aws_doc_sdk_examples_tools/doc_gen_test.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ def test_doc_gen_load_snippets():
240240

241241

242242
def test_fill_fields(sample_doc_gen: DocGen):
243-
sample_doc_gen.fill_fields()
243+
sample_doc_gen.fill_missing_fields()
244244
example = sample_doc_gen.examples["s3_PutObject"]
245245
assert example.title == "<code>PutObject</code>"
246246
assert example.title_abbrev == "ExcerptPartsUsage"

aws_doc_sdk_examples_tools/metadata.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ class Example:
149149
synopsis_list: List[str] = field(default_factory=list)
150150
source_key: Optional[str] = field(default=None)
151151

152-
def fill_title(self, categories: Dict[str, Category], service, action):
152+
def fill_display_fields(self, categories: Dict[str, Category], service, action):
153153
category = self.choose_category(categories)
154154
if category:
155155
self.title = category.evaluate(

0 commit comments

Comments
 (0)