Skip to content

Commit 8715f19

Browse files
committed
Note that const and non-const versions of the same function are fine
1 parent 01bdfef commit 8715f19

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/documentation/doc-alias-policy.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ cases where we add doc aliases, and the cases where we omit those aliases.
2727
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
30-
declarations. We will also not add an alias for a function that's only
31-
somewhat similar or related.
30+
declarations. (`const` and non-`const` versions of the same function are
31+
fine.) We will also not add an alias for a function that's only somewhat
32+
similar or related.
3233
- The alias must not conflict with the actual name of any existing declaration.
3334
- As a special case for stdarch, aliases from exact assembly instruction names
3435
to the corresponding intrinsic function are welcome, as long as they don't

0 commit comments

Comments
 (0)