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.

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

Revisit rustc-ux-guidelines with updates #34808

Closed
Havvy opened this issue Jul 13, 2016 · 0 comments · Fixed by #41791
Closed

Revisit rustc-ux-guidelines with updates #34808

Havvy opened this issue Jul 13, 2016 · 0 comments · Fixed by #41791

Comments

@Havvy
Copy link
Contributor

Havvy commented Jul 13, 2016

Rustc UX Guidelines doc.

It's been awhile since it's been updated. Here's two changes that haven't been merged into this document yet:

Havvy added a commit to Havvy/rust that referenced this issue Jul 17, 2016
This is a partial fix for issue rust-lang#34808.

Most of the wording was copied verbatim from the RFC. Main difference is that I moved the actual template to the top of the section.

It also makes the error explanations the longest section in the guidelines doc for now.
steveklabnik added a commit to steveklabnik/rust that referenced this issue Jul 25, 2016
Merge guidelines from RFC 1567 into UX Guidelines.

This is a partial fix for issue rust-lang#34808.

Most of the wording was copied verbatim from the RFC. Main difference is that I moved the actual template to the top of the section.

It also makes the error explanations the longest section in the guidelines doc for now.
Havvy added a commit to Havvy/rust that referenced this issue Aug 1, 2016
This is a partial fix for issue rust-lang#34808.

Most of the wording was copied verbatim from the RFC. Main difference is that I moved the actual template to the top of the section.

It also makes the error explanations the longest section in the guidelines doc for now.
sophiajt pushed a commit to sophiajt/rust that referenced this issue Aug 4, 2016
Merge guidelines from RFC 1567 into UX Guidelines.

This is a partial fix for issue rust-lang#34808.

Most of the wording was copied verbatim from the RFC. Main difference is that I moved the actual template to the top of the section.

It also makes the error explanations the longest section in the guidelines doc for now.
steveklabnik added a commit to steveklabnik/rust that referenced this issue Aug 4, 2016
Merge guidelines from RFC 1567 into UX Guidelines.

This is a partial fix for issue rust-lang#34808.

Most of the wording was copied verbatim from the RFC. Main difference is that I moved the actual template to the top of the section.

It also makes the error explanations the longest section in the guidelines doc for now.
bors added a commit that referenced this issue May 7, 2017
Minor cleanup of UX guidelines.

I think this fixes #34808. It covers the [long error code explanations normalization] by linking to the RFC, and cleaning up the list where long diagnostics are defined. While the [error message overhaul] isn't covered directly, I'm not really sure that more than the [existing section] on the error/warning/help messages is warranted; the overhaul linked didn't really specify any new guidelines, primarily just changing the output format.

[Long error code explanations normalization]: https://github.com/rust-lang/rfcs/blob/master/text/1567-long-error-codes-explanation-normalization.md
[Error message overhaul]: #33240
[existing section]: https://github.com/rust-lang/rust/blob/master/src/doc/rustc-ux-guidelines.md#error-warning-help-note-messages
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant