Skip to content

Commit 27898ab

Browse files
committed
Drop delete example; give example of rmdir instead
1 parent 8715f19 commit 27898ab

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/documentation/doc-alias-policy.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ cases where we add doc aliases, and the cases where we omit those aliases.
2121
exist in Rust (e.g. a system function or a C library function), to try to
2222
figure out what Rust called that function.
2323
- The proposed alias must be a name we would plausibly have used for the
24-
declaration. For instance, `delete` for `remove`, or `popcnt` and `popcount`
25-
for `count_ones`, or `umask` for `mode`, or `mkdir` for `create_dir`. This
26-
feeds into the reasonable expectation that someone might search for the name
27-
and expect to find it ("what did Rust call `mkdir`").
24+
declaration. For instance, `rmdir` for `remove_dir`, or `popcnt` and
25+
`popcount` for `count_ones`, or `umask` for `mode`, or `mkdir` for
26+
`create_dir`. This feeds into the reasonable expectation that someone might
27+
search for the name and expect to find it ("what did Rust call `mkdir`").
2828
- There must be an obvious single target for the alias that is an *exact*
2929
analogue of the aliased name. We will not add the same alias to multiple
3030
declarations. (`const` and non-`const` versions of the same function are

0 commit comments

Comments
 (0)