docs(spec): remaining audit edits (errors, init/add/get/status text + R signatures, audit-log JSON, threading)#149
Open
CGMossa wants to merge 5 commits into
Open
docs(spec): remaining audit edits (errors, init/add/get/status text + R signatures, audit-log JSON, threading)#149CGMossa wants to merge 5 commits into
CGMossa wants to merge 5 commits into
Conversation
CGMossa
changed the title
CGMossa
force-pushed
the
spec-review-april-2
branch
from
63624c4 to
dd513bb
Compare
This comment was marked as outdated.
This comment was marked as outdated.
CGMossa
force-pushed
the
spec-review-april-2
branch
from
102bf23 to
ff6b520
Compare
2 tasks
CGMossa
force-pushed
the
spec-review-april-2
branch
from
547ef2b to
0d9396d
Compare
CGMossa
added a commit
that referenced
this pull request
May 16, 2026
specs.md said "4 states" but only listed 3 (current, absent, unsynced) plus the obsolete `untracked`. dvs no longer surfaces an `untracked` state — `dvs status` operates on tracked files (those with metadata), not on arbitrary files in the project tree. Drop the bullet and fix the count. Carved out of #149.
This was referenced May 16, 2026
CGMossa
changed the title
CGMossa
added a commit
that referenced
this pull request
May 17, 2026
specs.md said "4 states" but only listed 3 (current, absent, unsynced) plus the obsolete `untracked`. dvs no longer surfaces an `untracked` state — `dvs status` operates on tracked files (those with metadata), not on arbitrary files in the project tree. Drop the bullet and fix the count. Carved out of #149.
CGMossa
added a commit
that referenced
this pull request
May 17, 2026
#201) Collected small spec edits with no behavioral content: - L29 strip trailing space on `\`init\` will create the \`dvs.toml\`. ` - L36 fix the gitignore step: it's the metadata file (and adjacent data file) being added, not "each file" — matches the actual implementation in dvs::gitignore::* - L50 drop double blank line before `## In-depth spec` - L155 capitalization `#### R Package` → `#### R package` (the other three sections already use lowercase "package") - L351 globbing section: `\`add\` and \`get\` both accept` → `\`add\`, \`status\`, \`get\` accept` (status accepts --glob too; "both" is also wrong for three operations) Carved out of #149.
CGMossa
added a commit
that referenced
this pull request
May 17, 2026
Regenerated from actual `dvs <sub> --help` output. All four blocks
now reflect:
- the global `--threads <THREADS>` option (init/add/get/status)
- get/status's expanded column widths from the longer --threads label
- status's new positional `[PATHS]...` + `-r, --recursive` +
`--with-metadata` flags
- status's updated one-liner ("Gets the status of each files in the
current repository") and removed "By default shows all tracked
files..." paragraph
- consistent `shell` language tag on the fenced blocks
- consistent `❯` prompt (stripped stray U+F432 Nerd Font glyphs from
the original copy-paste)
Carved out of #149.
CGMossa
added a commit
that referenced
this pull request
May 17, 2026
Two short subsections under the High-level overview, recording rules already enforced in the implementation but not previously written down: - Relative paths vs. absolute paths: every `dvs` command accepts both forms; project-scope / symlink resolution is the library's responsibility. - R package: pass `NULL` in `dvs_*` functions to defer to the library's default value. The "Rust library must never use std::io" rule from the original spec audit pass is intentionally omitted — the broader no-CLI/R-package-coupling invariant on the same topic already landed on main via #195. Carved out of #149.
CGMossa
force-pushed
the
spec-review-april-2
branch
from
2e9628c to
535784b
Compare
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
1 participant
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.
REPURPOSED PR: This is now a PR providing amendments to the
specs.mdthat are broader in scope, and R package specific.AI-written details
Status: residual after Wave 1 splits
This PR was the original "spec audit april" pass (178 +/45 -). It has been carved up into focused PRs; what remains here is the content that's either harder to verify against current code or still blocked on author decisions.
Already extracted
lib.rsmod comment (the only non-spec change)untrackedfrom file-state model (4 → 3 states)--helpblocks for init/add/get/statusRemaining here
#### CLIand#### R packagesubsections — blocked: the empty subsections need content before this can land.metadata_folder_nameomitted when default; Library section prose;dvs_initR signature change (root_dir = NULL,compression = c("zstd", "none"), dropsno_compression); return prose update.dvs_addR signature (paths,dry_run = NULL); partial-completion contract paragraph.dvs_getR signature (paths,dry_run = NULL); partial-completion contract paragraph.dvs_statusR signature (paths,recursive,statusfilter vector); bullet rewrite.addobject shape (file+compression); worked JSON example.#### R packagesubsection — partially blocked: tied to the threading-strategy TODO at the original L419.Follow-up needed before this can merge
dvs-rpkg/R/dvs-commands.Rafter rpkg: dvs_init returns config as a single-row tibble #170, feat(rpkg): return event state as data.frame or list-of-data.frames #193, feat: add --recursive to dvs get (SUPERSEDED — split into #203 + #204 + #205) #154 land — the signatures here are aspirationalTest plan
Drafted by Claude (claude-opus-4-7). Reviewed by the author.