docs: repoint the doc comments at the marker they describe
The store moved to `.kettle/` when the binary replaced the plugin's scripts, but six doc comments in the domain and the project layer still showed `.tea/` paths in their examples. The code was right and the prose was a version behind, which is the failure mode worth catching early: these are the comments somebody reads to learn where the store IS. The `.tea/` that remain are the ones that mean it — the legacy migration list and the tests that exercise it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -13,7 +13,7 @@
|
|||||||
// Identity is a slug derived from the title, and it is the only identity the
|
// Identity is a slug derived from the title, and it is the only identity the
|
||||||
// domain has. The file name is the id:
|
// domain has. The file name is the id:
|
||||||
//
|
//
|
||||||
// .tea/issues/wire-sqlc-appclick.md
|
// .kettle/issues/wire-sqlc-appclick.md
|
||||||
//
|
//
|
||||||
// ---
|
// ---
|
||||||
// id: wire-sqlc-appclick
|
// id: wire-sqlc-appclick
|
||||||
@@ -40,8 +40,8 @@
|
|||||||
// Every metadata field is one line and lists are inline, so plain grep works
|
// Every metadata field is one line and lists are inline, so plain grep works
|
||||||
// without a parser:
|
// without a parser:
|
||||||
//
|
//
|
||||||
// grep -l 'labels:.*type/bug' .tea/issues/*.md
|
// grep -l 'labels:.*type/bug' .kettle/issues/*.md
|
||||||
// grep -ln 'depends:.*migrate-schema' .tea/issues/*.md # who depends on it
|
// grep -ln 'depends:.*migrate-schema' .kettle/issues/*.md # who depends on it
|
||||||
package issue
|
package issue
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|||||||
@@ -55,15 +55,15 @@ func (e *ClashError) Error() string {
|
|||||||
|
|
||||||
// Init makes root a project. Everything it does is idempotent:
|
// Init makes root a project. Everything it does is idempotent:
|
||||||
//
|
//
|
||||||
// - creates .tea/issues/ and .tea/payload/
|
// - creates .kettle/issues/ and .kettle/payload/
|
||||||
// - moves an existing tmp/issues/ and tmp/payload/ in, if it finds them
|
// - moves an older store in, if it finds one — see `legacy`, oldest first
|
||||||
// - adds .tea/ to .gitignore
|
// - adds .kettle/ to .gitignore
|
||||||
//
|
//
|
||||||
// The move is the migration off the old layout and it is a move, not a copy:
|
// The move is the migration off an older layout and it is a move, not a copy:
|
||||||
// two stores is the state the marker exists to prevent, and a store left behind
|
// two stores is the state the marker exists to prevent, and a store left behind
|
||||||
// at the old path is a store somebody will edit by accident.
|
// at the old path is a store somebody will edit by accident.
|
||||||
//
|
//
|
||||||
// .tea/ is gitignored because an `origin: local` issue is the only copy of that
|
// .kettle/ is gitignored because an `origin: local` issue is the only copy of that
|
||||||
// work and the operator, not this command, decides what goes in a shared
|
// work and the operator, not this command, decides what goes in a shared
|
||||||
// history. Committing the store is a legitimate choice — drop the line if you
|
// history. Committing the store is a legitimate choice — drop the line if you
|
||||||
// make it.
|
// make it.
|
||||||
|
|||||||
Reference in New Issue
Block a user