vim-patch:d6d4e13: runtime(doc): rewrite mkdir() doc and simplify {flags} meaning

related: vim/vim#14991

d6d4e13336

Co-authored-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
zeertzjq 2024-06-15 06:04:13 +08:00
parent 0600754d8d
commit f557a985ef
3 changed files with 21 additions and 30 deletions

View File

@ -4994,17 +4994,14 @@ mkdir({name} [, {flags} [, {prot}]]) *mkdir()* *E73
When {flags} is present it must be a string. An empty string When {flags} is present it must be a string. An empty string
has no effect. has no effect.
If {flags} contains "p" then intermediate directories are {flags} can contain these character flags:
created as necessary. "p" intermediate directories will be created as necessary
"D" {name} will be deleted at the end of the current
function, but not recursively |defer|
"R" {name} will be deleted recursively at the end of the
current function |defer|
If {flags} contains "D" then {name} is deleted at the end of Note that when {name} has more than one part and "p" is used
the current function, as with: >vim
defer delete({name}, 'd')
<
If {flags} contains "R" then {name} is deleted recursively at
the end of the current function, as with: >vim
defer delete({name}, 'rf')
< Note that when {name} has more than one part and "p" is used
some directories may already exist. Only the first one that some directories may already exist. Only the first one that
is created and what it contains is scheduled to be deleted. is created and what it contains is scheduled to be deleted.
E.g. when using: >vim E.g. when using: >vim

View File

@ -6007,17 +6007,14 @@ function vim.fn.min(expr) end
--- When {flags} is present it must be a string. An empty string --- When {flags} is present it must be a string. An empty string
--- has no effect. --- has no effect.
--- ---
--- If {flags} contains "p" then intermediate directories are --- {flags} can contain these character flags:
--- created as necessary. --- "p" intermediate directories will be created as necessary
--- "D" {name} will be deleted at the end of the current
--- function, but not recursively |defer|
--- "R" {name} will be deleted recursively at the end of the
--- current function |defer|
--- ---
--- If {flags} contains "D" then {name} is deleted at the end of --- Note that when {name} has more than one part and "p" is used
--- the current function, as with: >vim
--- defer delete({name}, 'd')
--- <
--- If {flags} contains "R" then {name} is deleted recursively at
--- the end of the current function, as with: >vim
--- defer delete({name}, 'rf')
--- <Note that when {name} has more than one part and "p" is used
--- some directories may already exist. Only the first one that --- some directories may already exist. Only the first one that
--- is created and what it contains is scheduled to be deleted. --- is created and what it contains is scheduled to be deleted.
--- E.g. when using: >vim --- E.g. when using: >vim

View File

@ -7264,17 +7264,14 @@ M.funcs = {
When {flags} is present it must be a string. An empty string When {flags} is present it must be a string. An empty string
has no effect. has no effect.
If {flags} contains "p" then intermediate directories are {flags} can contain these character flags:
created as necessary. "p" intermediate directories will be created as necessary
"D" {name} will be deleted at the end of the current
function, but not recursively |defer|
"R" {name} will be deleted recursively at the end of the
current function |defer|
If {flags} contains "D" then {name} is deleted at the end of Note that when {name} has more than one part and "p" is used
the current function, as with: >vim
defer delete({name}, 'd')
<
If {flags} contains "R" then {name} is deleted recursively at
the end of the current function, as with: >vim
defer delete({name}, 'rf')
<Note that when {name} has more than one part and "p" is used
some directories may already exist. Only the first one that some directories may already exist. Only the first one that
is created and what it contains is scheduled to be deleted. is created and what it contains is scheduled to be deleted.
E.g. when using: >vim E.g. when using: >vim