Skip to content

consumer-profiles.md contains internal planning text meaningless to external readers #136

Description

@codeforester

Problem

docs/consumer-profiles.md:167–168 contains developer planning notes that have no meaning to an external reader:

The package rename is deliberately separate from this refactor. Names can be changed after the dependency boundary is stable.

An adopter reading this doc has no context for:

  • What rename is being contemplated
  • What the "refactor" refers to
  • What the "dependency boundary" means
  • Why this paragraph appears in a guide about consumer profiles

This reads as an internal TODO comment that was accidentally included in the public documentation during a refactor.

Fix

Remove these two sentences entirely. If there is a relevant consumer-facing message (e.g., "the stable import path is import base_cli; the package name on PyPI is base-cli"), replace with that instead. Otherwise, the surrounding paragraph is self-contained without these lines.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status
Backlog

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions