Skip to content

Commit 422a64f

Browse files
lolbinarycatMark-Simulacrum
authored andcommitted
Preparing Release Notes: clarify stablizing trait impls
I've seen this done a few different ways (sometimes they even show up in the language section), and I think this is the way that makes the most sense.
1 parent 7d87106 commit 422a64f

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/release/release-notes.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ Stabilized APIs and Const Stabilized APIs should both be formatted roughly as fo
4848

4949
```md
5050
- [`std::ptr::null_mut`](https://doc.rust-lang.org/std/ptr/fn.null_mut.html)
51+
<!-- for trait implemenations: -->
52+
- [`impl<T: Clone, const N: usize> From<&[T; N]> for Vec<T>`](https://doc.rust-lang.org/stable/std/vec/struct.Vec.html#impl-From%3C%26%5BT;+N%5D%3E-for-Vec%3CT,+Global%3E)
5153
```
5254

5355
Note that:
@@ -56,7 +58,10 @@ Note that:
5658
* the link is to stable docs (and so may not actually work at time of writing)
5759
* the API is directly noted. Sometimes we compress APIs (e.g., `uN` for
5860
unsigned integers) to avoid too much text.
59-
61+
* link fragments can be long and hard to predict, so it is often better to copy and paste the url than write it manually
62+
(if the item doesn't appear in stable docs, you can copy it from nightly and edit the url).
63+
* if the only thing being stablized is trait implementations (and not the corrosponding trait),
64+
all impls are listed with links to the corrosponding impl blocks.
6065
## Release team: Step 3: Confirm all issues/PRs needing relnotes are labeled `relnotes`
6166

6267
This steps should happen in the first 3 weeks of the beta period (earlier is

0 commit comments

Comments
 (0)