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

rustdoc: Emoji for deprecated items #67872

Closed
tesuji opened this issue Jan 4, 2020 · 11 comments · Fixed by #72014
Closed

rustdoc: Emoji for deprecated items #67872

tesuji opened this issue Jan 4, 2020 · 11 comments · Fixed by #72014
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@tesuji
Copy link
Contributor

tesuji commented Jan 4, 2020

Nightly only items have emoji:
image

I think deprecated items should have emoji too.
For example this item: https://doc.rust-lang.org/nightly/std/primitive.str.html#method.trim_right
@pickfire suggests using coffin emoji ⚰️ in #67868 (comment)
I suggest using fire emoji: 🔥

@tesuji
Copy link
Contributor Author

tesuji commented Jan 4, 2020

cc #67871

@DataTriny
Copy link

Hello,
I personally think that the coffin emoji convey better the idea that the item should not be used anymore (it's dead). Fire can have multiple significations in my opinion.

@kennytm
Copy link
Member

kennytm commented Jan 4, 2020

For reference, MDN uses

  • 🗑 (trash can) for Obsoleted and won't work
  • ⚠️ (warning sign) for Non-standard
  • 👎 (thumbs down) for Deprecated but still works
  • ⚗️ (*actually, a beaker) for Experimental

(that said, I think it's fine to use no emoji)

@euclio
Copy link
Contributor

euclio commented Jan 4, 2020

I commented on the open PR already, but I'll add my sentiments here, too.

Other options to consider:

  • 👎
  • 🕸
  • 🚨
  • 🚧
  • 🛑
  • 🚫
  • 🟡
  • 🟨
  • 🚩
  • ⚠️

I'm personally partial to 🚩 and ⚠️. I think they convey the message of "hey, pay attention, this will go away at some point" without being too strong or prescriptive. I like 👎 too given the definition of "deprecate" ("express disapproval of"), and that MDN already uses it.

I also like 🚧 but it may have too much of a "under construction, stabilizing" connotation than we would like, though.

I dislike the coffin because it is difficult to tell what it is from a glance (also, it's too grim for my tastes).

@ExpHP
Copy link
Contributor

ExpHP commented Jan 4, 2020

🚩 and ⚠️ looks more like they mean "unsafe" to me.

I like 🕸, as it both has a fairly unambiguous meaning and seems kinda cute.

✋ is another option but feels ambiguous and is generally inferior to 🛑. (on some platforms it looks like it is waving)

@jonas-schievink jonas-schievink added C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jan 4, 2020
@pickfire
Copy link
Contributor

pickfire commented Jan 5, 2020

I like ⚰️ (conveys dead) and 👎 (conveys not recommended) symbol.
I cannot understand why 🔥 (conveys burning? power?) and 🕸️ (conveys slow?) means deprecated.

@tesuji tesuji changed the title Emoji for deprecated items rustdoc: Emoji for deprecated items Jan 5, 2020
@tesuji
Copy link
Contributor Author

tesuji commented Jan 5, 2020

It just come to my mind after your suggestion of ⚰️ . I think 🔥 means things
to be burnt to ashes.

@kennytm
Copy link
Member

kennytm commented Jan 5, 2020

#37250 already used ⚠️ to mean "unsafe".

@pickfire
Copy link
Contributor

pickfire commented Jan 5, 2020

@kennytm Yes, I noticed ⚠️ already being used. We also use that here.

@Ixrec
Copy link
Contributor

Ixrec commented Jan 11, 2020

I agree that 👎 conveys "not recommended", but I don't see that as a problem. "Deprecated" is often synonymous with "not recommended" (especially when compatibility forbids ever removing the item), and that's certainly the most important part of what "deprecated" means for the end user.

Without any other context, 🕸 looks to me more like a snowflake than a cobweb (at least the ways github/gmail render it in Chrome), which obviously doesn't quite work.

⚰️ does look like a coffin to me, but in a way I suspect is fragile. I could easily imagine a slightly different size or image choice making it look more like a cigar or a chocolate bar or something else that obviously doesn't work.

A lot of the other suggestions like 🗑 and ❌ and 🛑 feel closer to "deleted" or "disabled" than the "deprecated" we're after here.

I think ⚠️ is one of the better choices for unsafe because it expresses danger without implying that there's any construction or destruction or other temporary work in progress; just a general "be aware" without any other baggage. It also doesn't express disapproval (after all, there's nothing wrong with using unsafe when appropriate). So even if it wasn't already being used for that, I'd keep it there.

In the end 👎 seems like the strongest candidate for "deprecated", given all of those extremely subjective opinions.

@GuillaumeGomez
Copy link
Member

Ok, then I'll add the 👎 emoji for deprecated items!

Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue May 9, 2020
…kinnison,ollie27

Deprecated emoji

Fixes rust-lang#67872.

r? @kinnison

cc @rust-lang/rustdoc
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue May 9, 2020
…kinnison,ollie27

Deprecated emoji

Fixes rust-lang#67872.

r? @kinnison

cc @rust-lang/rustdoc
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue May 10, 2020
…kinnison,ollie27

Deprecated emoji

Fixes rust-lang#67872.

r? @kinnison

cc @rust-lang/rustdoc
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue May 11, 2020
…kinnison,ollie27

Deprecated emoji

Fixes rust-lang#67872.

r? @kinnison

cc @rust-lang/rustdoc
RalfJung added a commit to RalfJung/rust that referenced this issue May 11, 2020
…kinnison,ollie27

Deprecated emoji

Fixes rust-lang#67872.

r? @kinnison

cc @rust-lang/rustdoc
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue May 11, 2020
…kinnison,ollie27

Deprecated emoji

Fixes rust-lang#67872.

r? @kinnison

cc @rust-lang/rustdoc
@bors bors closed this as completed in dd595fa May 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

9 participants