docs(spec): add high-level conventions — paths, NULL defer#200
Open
CGMossa wants to merge 1 commit into
Open
Conversation
CGMossa
added a commit
that referenced
this pull request
May 16, 2026
5 tasks
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.
a54eeb2 to
3246e32
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
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.
Unique design choice, where R API is treating
NULLas default value by library. This means, that NULL is not a fancy way of writing 0, because it may result in non-zero settings.AI-written details
Summary
dvscommand accepts both forms; project-scope / symlink resolution is the library's responsibility, not the caller's.NULLindvs_*functions when you want to defer to the library's default value.std::io::{Stdin, Stdout, Stderr}" subsection. Omitted here on purpose — the broader no-CLI/no-R-package coupling invariant on the same topic already landed on main via spec: require dvs core to be free of CLI/R-package concerns #195 /9df3750, and re-stating a narrower form alongside it would just create drift.Test plan
dvs_*R wrapper indvs-rpkg/R/contradicts the NULL-defer ruleDrafted by Claude (claude-opus-4-7). Reviewed by the author.