Move AGENTS.md sections into docs folder
This commit is contained in:
+1
-1
@@ -1,6 +1,6 @@
|
||||
//! Putting text on the clipboard of whatever terminal is drawing the board.
|
||||
//!
|
||||
//! OSC 52, written by hand, and the reasoning is in AGENTS.md under The Copy Key. The
|
||||
//! OSC 52, written by hand, and the reasoning is in docs/tui-prompts.md under The Copy Key. The
|
||||
//! short of it: the board is often being read over ssh, and an escape sequence is the
|
||||
//! only one of the three ways that crosses the connection. crossterm 0.28 is what
|
||||
//! ratatui 0.29 pins and it ships no clipboard command, so the sequence and the base64
|
||||
|
||||
+2
-2
@@ -211,7 +211,7 @@ const ACTOR_FROM_GIT_HELP: &str = "Attribute the entry to the detected git user
|
||||
///
|
||||
/// Ticket text quotes flag names constantly, and without this a criterion reading
|
||||
/// "--print is supported" is parsed as a flag and the whole ticket is refused. The
|
||||
/// trade, spelled out in AGENTS.md: on these arguments a genuinely mistyped flag
|
||||
/// trade, spelled out in docs/cli-arguments.md: on these arguments a genuinely mistyped flag
|
||||
/// now lands as content instead of raising a usage error. That is the right way
|
||||
/// round for prose, and it is why `due`, `priority`, `tags`, `owner` and `status`
|
||||
/// are deliberately left without it.
|
||||
@@ -631,7 +631,7 @@ pub struct TagSetArgs {
|
||||
}
|
||||
|
||||
/// `ls` holds four filters, an output mode and nothing else, which is the boundary the
|
||||
/// Rust Style rule in AGENTS.md names: two of the filters are adjacent `Option<String>`
|
||||
/// Rust Style rule in docs/rust-style.md names: two of the filters are adjacent `Option<String>`
|
||||
/// values that a caller can swap silently, so the mode that joined them came as a
|
||||
/// struct rather than a sixth parameter, the way `add` became [`AddArgs`].
|
||||
#[derive(clap::Args)]
|
||||
|
||||
+1
-1
@@ -35,7 +35,7 @@ pub const TICKET_COMMANDS: [&str; 8] = [
|
||||
/// Subcommands whose *second* positional is the ticket, because they name two things.
|
||||
///
|
||||
/// `chown alice <ticket>` and `assign "v1 release" <ticket>`, which put the ticket
|
||||
/// second deliberately, see AGENTS.md. The first argument of each is a user or a
|
||||
/// second deliberately, see docs/editing-tickets.md. The first argument of each is a user or a
|
||||
/// campaign, and neither is completed.
|
||||
pub const TICKET_SECOND_COMMANDS: [&str; 2] = ["chown", "assign"];
|
||||
|
||||
|
||||
+3
-3
@@ -55,7 +55,7 @@ const ALL: &str = "all";
|
||||
///
|
||||
/// A struct rather than two bools threaded through `screen_rows`, `board_area`,
|
||||
/// `card_width` and `column_text_height`: adjacent same-typed parameters are what the
|
||||
/// Rust Style rule in AGENTS.md warns about, and a caller that swapped them would measure
|
||||
/// Rust Style rule in docs/rust-style.md warns about, and a caller that swapped them would measure
|
||||
/// a board nobody is looking at. Copied from `Board::chrome`, so the draw and the
|
||||
/// keypress measure one answer.
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||
@@ -6006,7 +6006,7 @@ mod tests {
|
||||
///
|
||||
/// A separate fixture rather than a sixth parameter on `write_tagged_card`: the
|
||||
/// callers that care about tags do not care about campaigns, and five string
|
||||
/// arguments in a row is what the Rust Style rule in AGENTS.md warns about.
|
||||
/// arguments in a row is what the Rust Style rule in docs/rust-style.md warns about.
|
||||
fn write_member_card(dir: &Path, title: &str, tags: &str, campaign: &str) {
|
||||
let uuid = FIXTURE_UUID;
|
||||
std::fs::write(
|
||||
@@ -10575,7 +10575,7 @@ approach";
|
||||
/// A separate fixture rather than a sixth parameter on `write_campaign`, the split
|
||||
/// `write_member_card` already makes: only the tests about the completed section's
|
||||
/// order care when a campaign was filed, and five string arguments in a row is what
|
||||
/// the Rust Style rule in AGENTS.md warns about.
|
||||
/// the Rust Style rule in docs/rust-style.md warns about.
|
||||
fn write_dated_campaign(dir: &Path, uuid: &str, title: &str, created_at: &str) {
|
||||
let campaigns = dir.join(CAMPAIGNS_DIR);
|
||||
std::fs::create_dir_all(&campaigns).unwrap();
|
||||
|
||||
+3
-3
@@ -98,7 +98,7 @@ impl Color {
|
||||
// palette: 90 leans on the bright-black slot and 37 can sit right on top
|
||||
// of the default foreground.
|
||||
Color::Grey => "\x1b[38;5;8m",
|
||||
// Bold, per the guideline in AGENTS.md.
|
||||
// Bold, per the guideline in docs/color.md.
|
||||
Color::Magenta => "\x1b[1;35m",
|
||||
// Indexed, for the same reason grey is: this is the spelling that renders.
|
||||
Color::BrightRed => "\x1b[38;5;9m",
|
||||
@@ -140,7 +140,7 @@ impl Color {
|
||||
/// The colours a tag may be drawn in.
|
||||
///
|
||||
/// Deliberately disjoint from the seven that already carry a meaning, per the guideline
|
||||
/// in AGENTS.md: a tag in red reads as a uuid, in green as a title, in grey as an unset
|
||||
/// in docs/color.md: a tag in red reads as a uuid, in green as a title, in grey as an unset
|
||||
/// value. Reserving slots here rather than picking at the call site is what keeps the
|
||||
/// next colour someone assigns from landing on top of the tags.
|
||||
///
|
||||
@@ -3088,7 +3088,7 @@ pub fn trim_blank_ends(values: &[String]) -> &[String] {
|
||||
///
|
||||
/// An enum rather than the string it was, so an unknown status is a usage error at parse
|
||||
/// time with the five listed, the way `priority_level` and `iso_date` refuse a bad level
|
||||
/// or date. That is the bargain the scalars already take, see AGENTS.md: nothing is
|
||||
/// or date. That is the bargain the scalars already take, see docs/cli-arguments.md: nothing is
|
||||
/// written, the exit code is 2, and no handler has to check. It also gives every shell
|
||||
/// that completes possible values the five names for free.
|
||||
///
|
||||
|
||||
Reference in New Issue
Block a user