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

Change metacrate description for crates.io #5215

Merged
merged 2 commits into from
Sep 23, 2024
Merged

Change metacrate description for crates.io #5215

merged 2 commits into from
Sep 23, 2024

Conversation

sffc
Copy link
Member

@sffc sffc commented Jul 10, 2024

This description shows up on our crates.io page and in search results:

https://crates.io/crates/icu

It doesn't say anything about ICU4X. I was working with @FrankYFTang today who thought we hadn't uploaded anything to crates.io because it wasn't evident in search results that the crate named icu is ICU4X.

This is especially important since the second search result is @filmil's rust_icu, which is ICU4C (and it says so in its description).

@sffc sffc requested a review from a team as a code owner July 10, 2024 02:30
zbraniecki
zbraniecki previously approved these changes Jul 10, 2024
Manishearth
Manishearth previously approved these changes Jul 10, 2024
@@ -4,7 +4,7 @@

[package]
name = "icu"
description = "International Components for Unicode"
description = "ICU4X Project: Unicode Internationalization Library for Rust"
Copy link
Member

Choose a reason for hiding this comment

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

"for Rust" is also not specific enough imho. rust-icu is "for Rust"

Suggested change
description = "ICU4X Project: Unicode Internationalization Library for Rust"
description = "International Components for Unicode, written in pure Rust (ICU4X)"

"ICU4X" should also be added as a keyword.

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

Also note this is icu; icu_capi could have a different description.

How's this?

Copy link
Member

Choose a reason for hiding this comment

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

I'm aware that this is icu, what does icu_capi have to do with this?

Also update the description of the icu4x crate to match.

Copy link
Member Author

Choose a reason for hiding this comment

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

The part about being "in Rust" is relevant because this is the Rust API. icu_capi should emphasize the non-Rust APIs.

Copy link
Member

Choose a reason for hiding this comment

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

I want it to say "in Rust" to emphasize that the whole thing is written in Rust (safe), as opposed to being bindings to C++ (unsafe). That a Rust crates exposes a Rust API is assumed.

Copy link
Member

Choose a reason for hiding this comment

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

I still think adding icu4x as a keyword is as important as adding it to the description.

Copy link
Member Author

Choose a reason for hiding this comment

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

I strongly agree with adding keywords, but let's not scope-creep this PR

@sffc sffc dismissed stale reviews from Manishearth and zbraniecki via cde866d July 10, 2024 17:25
@sffc sffc added the discuss-priority Discuss at the next ICU4X meeting label Aug 13, 2024
@sffc
Copy link
Member Author

sffc commented Aug 13, 2024

I think it will be a better use of time to just set aside 10 minutes of meeting time to wordsmith this together, rather than throwing drafts back and forth.

@sffc
Copy link
Member Author

sffc commented Aug 15, 2024

#5215

Agreed description of the icu crate: "ICU4X: International Components for Unicode, written in Rust"

Description of the icu4x crate: "For ICU4X, see the icu crate."

For comparison, rust_icu: "Native bindings to the ICU4C library from Unicode."

  • @echeran That description makes it sound like this is ICU4C but in Rust.
  • @robertbastian That's what ICU4X is, kind-of.
  • @echeran The APIs are different, for example.
  • @Manishearth ICU4X is intended as this newer thing.
  • @echeran And if you want ICU4C, you can use @filmil's rust_icu.
  • @echeran Overall I am okay with saying we are a variant of ICU; we've taken a lot of inspiration from it.

Decision:

  • Merge this PR
  • Also update the description of the icu4x crate as written above, but this cannot be in a PR because the crate does not exist in the repo.

LGTM: @sffc @Manishearth @echeran @robertbastian

@sffc sffc added waiting-on-author PRs waiting for action from the author for >7 days and removed discuss-priority Discuss at the next ICU4X meeting labels Aug 20, 2024
@sffc sffc merged commit 6356389 into main Sep 23, 2024
38 checks passed
@sffc sffc deleted the sffc-patch-2 branch September 23, 2024 18:56
@sffc
Copy link
Member Author

sffc commented Sep 23, 2024

I made a new issue to follow-up on changing the icu4x crate description: #5579

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
waiting-on-author PRs waiting for action from the author for >7 days
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants