Skip to content

Commit 19e4a4f

Browse files
committed
clarify what 'atomic' means in docs and mcp
1 parent 79a8e21 commit 19e4a4f

File tree

4 files changed

+23
-7
lines changed

4 files changed

+23
-7
lines changed

docs/src/content/docs/commands/plan.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,9 @@ renamify plan <OLD> <NEW> [PATHS]... [OPTIONS]
6060

6161
### Atomic Mode
6262

63+
"Atomic" means treating a search or replace identifier as a single unit,
64+
not splitting it into separate components. E.g. GitHub → github, not git_hub
65+
6366
- `--atomic` - Treat both search and replace terms as indivisible units
6467
- `--atomic-search` - Only treat search term as atomic
6568
- `--atomic-replace` - Only treat replace term as atomic

docs/src/content/docs/commands/rename.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,9 @@ renamify rename <OLD> <NEW> [PATHS]... [OPTIONS]
6969

7070
### Atomic Mode
7171

72+
"Atomic" means treating a search or replace identifier as a single unit,
73+
not splitting it into separate components. E.g. GitHub → github, not git_hub
74+
7275
- `--atomic` - Treat both search and replace terms as indivisible units
7376
- `--atomic-search` - Only treat search term as atomic
7477
- `--atomic-replace` - Only treat replace term as atomic

renamify-cli/src/cli/args.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,11 +128,11 @@ pub struct AtomicArgs {
128128
#[arg(long, conflicts_with_all = ["atomic_search", "atomic_replace"])]
129129
pub atomic: bool,
130130

131-
/// Treat search term as atomic (DocSpringdocspring, not doc_spring)
131+
/// Treat search term as atomic (GitHubgithub, not git_hub)
132132
#[arg(long)]
133133
pub atomic_search: bool,
134134

135-
/// Treat replace term as atomic (DocSpringdocspring, not doc_spring)
135+
/// Treat replace term as atomic (GitHubgithub, not git_hub)
136136
#[arg(long)]
137137
pub atomic_replace: bool,
138138

renamify-mcp/src/index.ts

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,15 @@ export function createServer(
7878
atomicSearch: z
7979
.boolean()
8080
.optional()
81-
.describe('Treat search term as atomic (indivisible unit)'),
81+
.describe(
82+
'Treat search term as atomic (GitHub → github, not git_hub)'
83+
),
8284
atomicReplace: z
8385
.boolean()
8486
.optional()
85-
.describe('Treat replace term as atomic (indivisible unit)'),
87+
.describe(
88+
'Treat replace term as atomic (GitHub → github, not git_hub)'
89+
),
8690
},
8791
},
8892
async (params) => {
@@ -149,7 +153,9 @@ export function createServer(
149153
atomicSearch: z
150154
.boolean()
151155
.optional()
152-
.describe('Treat search term as atomic (indivisible unit)'),
156+
.describe(
157+
'Treat search term as atomic (GitHub → github, not git_hub)'
158+
),
153159
},
154160
},
155161
async (params) => {
@@ -321,11 +327,15 @@ export function createServer(
321327
atomicSearch: z
322328
.boolean()
323329
.optional()
324-
.describe('Treat search term as atomic (indivisible unit)'),
330+
.describe(
331+
'Treat search term as atomic (GitHub → github, not git_hub)'
332+
),
325333
atomicReplace: z
326334
.boolean()
327335
.optional()
328-
.describe('Treat replace term as atomic (indivisible unit)'),
336+
.describe(
337+
'Treat replace term as atomic (GitHub → github, not git_hub)'
338+
),
329339
},
330340
},
331341
async (params) => {

0 commit comments

Comments
 (0)