Repository navigation
chore(terminology): complete prose sweep in docs/examples/ and Python docstrings (#1192 follow-up) #1279
Description
Epic: #929 | Parent issue: #1192 (swept in PR #1256)
Sequencing: No hard technical dependency — can land any time after Phase 1 settles to avoid terminology churn. Exception: docstrings on _generate_from_intrinsic() (marked Out of scope below) travel with the Phase 1 symbol rename in #1136 and must not be swept here.
PR #1256 swept docs/docs/, AGENTS.md, the five Phase 0 Python files, and all backend Python files already in the diff. Two areas were intentionally deferred to keep the PR stable for review:
1. docs/examples/ — prose terminology
These files were not touched by PR #1256 but contain the same old vocabulary:
| File | Line | Current text | Should be |
|---|---|---|---|
docs/examples/intrinsics/README.md |
1,3,7 | "Intrinsics Examples", "intrinsic functions" | "Adapter Functions Examples", "adapter functions" |
docs/examples/granite-switch/README.md |
3,29,36,57 | "intrinsics" prose, [Intrinsics Documentation] link |
"adapter functions", [Adapter functions Documentation] |
docs/examples/granite-switch/answerability_openai.py |
3 | "answerability intrinsic" | "answerability adapter function" |
docs/examples/granite-switch/manual_adapter_loading.py |
75 | "use the intrinsic as usual" | "use the adapter function as usual" |
docs/examples/aLora/README.md |
35, 144 | "upload your model as an intrinsic", "custom intrinsic adapter" | "adapter function" |
docs/examples/groundedness_requirement_example.py |
8 | "citations intrinsic" | "citations adapter function" |
docs/examples/tools/README.md |
18, 23 | "HuggingFace's smolagents", "HuggingFace ecosystem" | "Hugging Face" |
docs/examples/tools/smolagents_example.py |
2, 11 | "HuggingFace smolagents", "HuggingFace ecosystem" | "Hugging Face" |
docs/examples/aLora/README.md |
66, 87 | "HuggingFace model repository", "HuggingFace repo" | "Hugging Face" |
docs/examples/sessions/README.md |
91 | # HuggingFace |
# Hugging Face |
docs/examples/granite-switch/manual_adapter_loading.py |
12, 58 | "HuggingFace Hub" | "Hugging Face Hub" |
docs/examples/groundedness_requirement_example.py |
14, 32, 33 | "HuggingFace backend" | "Hugging Face backend" |
Note: --intrinsic CLI flag, stembolts_intrinsic.py filename, from mellea.stdlib.components.intrinsic import paths, and HuggingFaceTB/ org names in model IDs are all out of scope — leave unchanged.
2. Python docstrings/comments in files not in PR #1256
All are "Hugging Face" brand name corrections (not core terminology). 17 occurrences across 9 files:
| File | Occurrences |
|---|---|
mellea/backends/backend.py |
1 |
mellea/backends/tools.py |
2 |
mellea/backends/cache.py |
2 |
mellea/backends/model_ids.py |
2 (not lines 293/298 — those are org names in repo IDs, leave as-is) |
mellea/backends/model_options.py |
1 |
mellea/backends/kv_block_helpers.py |
2 (line 22 is a user-visible error string) |
mellea/formatters/granite/base/util.py |
6 |
mellea/stdlib/session.py |
1 |
mellea/core/base.py |
1 |
Out of scope (Phase 1 / Phase 4)
Docstrings that describe _generate_from_intrinsic() by name (openai.py:541,544, huggingface.py:508,511) travel with the symbol rename in Phase 1 (#1136) — do not sweep here.
Activity
planetf1 commentedon Jun 23, 2026
PR #1269 (#1136) has now merged (2026-06-23). That PR did not update the
_generate_from_intrinsic()docstrings inmellea/backends/huggingface.pyormellea/backends/openai.py— both still use old terminology ("intrinsic action", "intrinsic's I/O rewriter", "intrinsic_name"). The reason for the exclusion (avoiding conflict with an open PR) no longer applies. Please include those two docstrings in this sweep.chore(terminology): complete prose sweep in docs/examples/ and Python…
chore(terminology): fix missed HuggingFace→Hugging Face in rag.py, ch…
chore(terminology): fix two missed intrinsic→adapter function in docs (…
chore(terminology): fix two missed HuggingFace→Hugging Face in huggin…
chore(terminology): complete Hugging Face brand sweep (case variants) (…
chore(terminology): sweep docs/examples and Python docstrings (genera…