Skip to content

Commit 12a7e93

Browse files
committed
Address review feedback:
- Update changie entry - Have generic deprecated notice when no replacement is set - Replace description with deprecation text (no old description)
1 parent 356b3b0 commit 12a7e93

2 files changed

Lines changed: 11 additions & 9 deletions

File tree

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
kind: Under the Hood
2-
body: Update docs gen script to add deprecated tools to README
2+
body: Update docs gen script to annotate deprecated tools to README
33
time: 2026-07-06T10:11:05.118226-07:00

scripts/generate_docs.py

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -70,15 +70,17 @@ def generate_readme_tools_section() -> str:
7070

7171
sorted_tools = sorted(tool_names, key=lambda t: t.value)
7272
for tool in sorted_tools:
73-
desc = HUMAN_DESCRIPTIONS.get(tool, "")
7473
meta = _TOOL_META.get(tool)
75-
replacement = (
76-
meta.get("replacement") if meta and meta.get("deprecated") else None
77-
)
78-
suffix = (
79-
f" *(deprecated — use `{replacement}` instead)*" if replacement else ""
80-
)
81-
lines.append(f"- `{tool.value}`{suffix}: {desc}")
74+
if meta and meta.get("deprecated"):
75+
replacement = meta.get("replacement")
76+
desc = (
77+
f"*(deprecated — use `{replacement}` instead)*"
78+
if replacement
79+
else "*(deprecated)*"
80+
)
81+
else:
82+
desc = HUMAN_DESCRIPTIONS.get(tool, "")
83+
lines.append(f"- `{tool.value}`: {desc}")
8284

8385
lines.append("") # Empty line after each section
8486

0 commit comments

Comments
 (0)