Skip to content

Commit 3b87189

Browse files
committed
Updates several comments
1 parent c421c23 commit 3b87189

File tree

4 files changed

+16
-5
lines changed

4 files changed

+16
-5
lines changed

scripts/microgenerator/bigqueryclient.py.j2

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# TODO: Add a header if needed.
2+
3+
# ======== 🦕 HERE THERE BE DINOSAURS 🦖 =========
4+
# This content is subject to significant change. Not for review yet.
5+
# Included as a proof of concept for context or testing ONLY.
6+
# ================================================
7+
18
class BigQueryClient:
29
def __init__(self):
310
self._clients = {}

scripts/microgenerator/bigqueryclient_generator.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# TODO: Add a header if needed.
2+
13
import ast
24
import os
35
from collections import defaultdict
@@ -140,8 +142,8 @@ def generate_client_class_source(data):
140142
data = parse_files(FILES_TO_PARSE)
141143

142144
final_code = generate_client_class_source(data)
143-
# TODO: write final code to file.
144145

146+
# TODO: write final code to file instead of print to screen.
145147
print(final_code)
146148

147-
# Ensure black gets called on the generated source files as a final step.
149+
# TODO: Ensure blacken gets called on the generated source files as a final step.

scripts/microgenerator/config_helper.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# config_helper.py
1+
# TODO: Add a header if needed.
22

33
import yaml
44
import os

scripts/microgenerator/template_utils.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# TODO: Add a header if needed.
2+
13
import os
24
import jinja2
35

@@ -9,7 +11,7 @@ def load_template(template_name):
911
template_dir = os.path.dirname(os.path.abspath(__file__))
1012
env = jinja2.Environment(
1113
loader=jinja2.FileSystemLoader(template_dir),
12-
trim_blocks=True,
13-
lstrip_blocks=True,
14+
trim_blocks=True, # prevents blank lines by removing '\n' after block tags (e.g. {% if condition %}\n)
15+
lstrip_blocks=True, # prevents unwanted empty spaces before lines of text by removing non-explicit spaces, tabs, etc
1416
)
1517
return env.get_template(template_name)

0 commit comments

Comments
 (0)