rustdoc: Emoji for deprecated items

Created on 4 Jan 2020  ยท  11Comments  ยท  Source: rust-lang/rust

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 https://github.com/rust-lang/rust/pull/67868#issue-359222211
I suggest using fire emoji: :fire:

C-enhancement T-rustdoc

Most helpful comment

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)

All 11 comments

cc #67871

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.

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)

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).

๐Ÿšฉ 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)

I like :coffin: (conveys dead) and :-1: (conveys not recommended) symbol.
I cannot understand why :fire: (conveys burning? power?) and :spider_web: (conveys slow?) means deprecated.

It just come to my mind after your suggestion of :coffin: . I think :fire: means things
to be burnt to ashes.

37250 already used โš ๏ธ to mean "unsafe".

@kennytm Yes, I noticed :warning: already being used. We also use that here.

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.

Ok, then I'll add the :-1: emoji for deprecated items!

Was this page helpful?
0 / 5 - 0 ratings