chore(terminology): sweep docs/examples and Python docstrings (#1192 follow-up)#1322
Merged
planetf1 merged 5 commits intoJun 24, 2026
Merged
Conversation
… docstrings (generative-computing#1279) Follow-up to PR generative-computing#1256 which swept docs/docs/, AGENTS.md, and backend Python files. Two areas were intentionally deferred and are addressed here. - intrinsic → adapter function in README.md prose for intrinsics/, granite-switch/, aLora/, and groundedness_requirement_example.py - HuggingFace → Hugging Face (brand name) in tools/, granite-switch/, aLora/, and sessions/ examples - mellea/backends/backend.py (1) - mellea/backends/tools.py (2) - mellea/backends/cache.py (2) - mellea/backends/model_ids.py (3: lines 4, 22, 28) - mellea/backends/model_options.py (1) - mellea/backends/kv_block_helpers.py (2, including user-visible error string) - mellea/formatters/granite/base/util.py (6) - mellea/stdlib/session.py (1) - mellea/core/base.py (1) HuggingFaceTB/ org names in model IDs (lines 293/298 of model_ids.py) and all code identifiers/paths are left unchanged. Closes generative-computing#1279 Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
…at.py, docs/how-to Completeness audit during review caught four additional occurrences not covered by the initial sweep (generative-computing#1279 or generative-computing#1256): - mellea/stdlib/requirements/rag.py:37 — docstring prose - mellea/stdlib/components/chat.py:145 — inline comment - docs/docs/how-to/backends-and-configuration.md:36 — table link text - docs/docs/how-to/safety-guardrails.md:8 — prose sentence Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
…generative-computing#1279) Two prose occurrences missed by the initial sweep: - docs/docs/examples/index.md:83 — table row description - docs/docs/how-to/safety-guardrails.md:323 — Limitations section Found during code review completeness audit. Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
planetf1
force-pushed
the
worktree-issue-1279
branch
from
June 23, 2026 18:03
c69c2bc to
1921992
Compare
8 tasks
…gface.py (generative-computing#1279) Lines 265 (Raises docstring) and 342 (user-visible error string) were not in the issue's explicit file list but are in scope for the brand-name sweep. Found during pre-merge review audit. Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
8 tasks
…generative-computing#1279) Fix missed occurrences of `Huggingface` (lowercase f) and `huggingface` (all lowercase) in prose, docstrings, and comments. These were invisible to the initial camelCase-only grep. Detected by a case-insensitive sweep during pre-merge review. Files updated: - mellea/backends/huggingface.py (module docstring, class docstrings, comments, assertion/warning messages) - mellea/backends/tools.py, ollama.py, adapters/adapter.py (comments and docstrings) - mellea/formatters/granite/base/util.py (NotImplementedError message) - mellea/stdlib/requirements/safety/guardian.py (comment) - docs/examples/aLora/README.md, intrinsics/README.md, rag/README.md (code block comments and prose) Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
planetf1
marked this pull request as ready for review
June 24, 2026 08:58
planetf1
enabled auto-merge
June 24, 2026 10:01
jakelorocco
approved these changes
Jun 24, 2026
Merged
via the queue into
generative-computing:main
with commit Jun 24, 2026
d61204d
11 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Part of the terminology sweep epic (#1192, Epic #929). This is the second and final wave, completing the sweep across
docs/examples/,docs/docs/, and Python docstrings, comments, and user-visible strings. The first wave was #1256 (core source identifiers).HuggingFace/Huggingface/huggingface(prose) →Hugging Face(official two-word branding) in all docstrings, comments, and user-visible stringsintrinsic/intrinsicsprose →adapter function/adapter functionsin docs and examplesExclusions (intentionally unchanged):
HuggingFaceTB/org names in model IDs, Python identifiers (CustomIntrinsicAdapter,intrinsic_name,call_intrinsic), import paths (from mellea.backends.huggingface import),--intrinsicCLI flags,'huggingface'provider string literals, filenames/directory paths, URL path segments, glossary entries documenting both terms.Files changed (30)
mellea/backends/—huggingface.py,ollama.py,tools.py,backend.py,cache.py,kv_block_helpers.py,model_ids.py,model_options.py,adapters/adapter.pymellea/core/—base.pymellea/formatters/—granite/base/util.pymellea/stdlib/—session.py,components/chat.py,requirements/rag.py,requirements/safety/guardian.pydocs/examples/—intrinsics/README.md,aLora/README.md,rag/README.md,sessions/README.md,granite-switch/README.md+ 2.py,groundedness_requirement_example.py,tools/README.md+.pydocs/docs/—examples/index.md,how-to/backends-and-configuration.md,how-to/safety-guardrails.mdTest plan
uv run pytest test/ -m "not qualitative"— 2898 passed, 0 new failures (3 pre-existing failures in HF transformer integration tests unaffected by text changes)ruff format+ruff check— cleanHuggingface/huggingfacecase variants missed by initial camelCase-only grep; also fixed two proseintrinsicoccurrences and three code-block commentsRelationship to other open PRs
@akihikokuroda—docs/examples/tools/README.md): that PR restoresHuggingFacespelling on two lines already fixed here. Comment posted on docs: update docs/examples/tools/README.md #1328 to coordinate..parsedoverloads): touchescore/base.pyandsession.py— same files, different lines; simple rebase on merge.Closes #1279
Part of #1192
Part of #929