Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Link directly to stabilization report comments #1173

Merged
merged 1 commit into from
Jul 21, 2021
Merged

Link directly to stabilization report comments #1173

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions src/stabilization_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,18 +58,24 @@ The report should contain:
and describe the feature's behavior on encountering edge cases.
- Links to the documentations (the PRs we have made in the
previous steps).
- Any other relevant information(Examples of such reports can
be found in rust-lang/rust#44494 and rust-lang/rust#28237).
- Any other relevant information.
- The resolutions of any unresolved questions if the stabilization
is for an RFC.

Examples of stabilization reports can be found in
[rust-lang/rust#44494][report1] and [rust-lang/rust#28237][report2] (these links
will bring you directly to the comment containing the stabilization report).
Comment on lines +66 to +67
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I appreciate you doing the work :) but I don't think it needs to be called out specifically in the docs.

Suggested change
[rust-lang/rust#44494][report1] and [rust-lang/rust#28237][report2] (these links
will bring you directly to the comment containing the stabilization report).
[rust-lang/rust#44494][report1] and [rust-lang/rust#28237][report2].

Copy link
Member Author

@camelid camelid Jul 20, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason I included that phrase was so people wouldn't be daunted by seeing an issue number and thinking they'd have to scroll through a ton of comments. I also thought of writing something like

Examples of stabilization reports can be found here and here

but I thought it might be better to keep the issue numbers.

I'm okay with removing that phrase if you don't think it'll be daunting to people without it though :)

Let me know if you'd still like me to remove it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think removing it is fine - they wouldn't have reason to think ahead of time that the comment chain is super long. But I don't feel super strongly about it.


[report1]: https://github.com/rust-lang/rust/issues/44494#issuecomment-360191474
[report2]: https://github.com/rust-lang/rust/issues/28237#issuecomment-363374130

## FCP

If any member of the team responsible for tracking this
feature agrees with stabilizing this feature, they will
start the FCP (final-comment-period) process by commenting

```bash
```text
@rfcbot fcp merge
```

Expand Down