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

It is hard to guess the behavior of the yank subcommand of the publish command for non-native speakers #264

Open
chikoski opened this issue Apr 23, 2024 · 6 comments

Comments

@chikoski
Copy link

The name of the yank subcommand of the publish command is confusing enough for me to make my interface package yanked unintentionally. The names of commands should be clear so that non-native English speakers can guess their behavior with less effort.

I understand yank means "making it unavailable for use" in this context, but I need 5 English-Japanese dictionaries and 15mins
to find the meaning.

@chikoski chikoski changed the title It is hard to assume the behavior of the "yank" subcommand of "warg publish" for non-native speakers It is hard to guess the behavior of the yank subcommand of the publish command for non-native speakers Apr 23, 2024
@calvinrp
Copy link
Collaborator

Thanks for pointing this out as confusing. Do you think it should be renamed? Or just requires clearer description and messaging in the CLI?

@lann
Copy link
Collaborator

lann commented Apr 23, 2024

This terminology is borrowed from Rust's cargo yank. I don't know that there is a single better word for the operation (suggestions welcome!) but it is quite likely that documentation and UX around the operation could be improved. I suspect that it should probably be gated by a confirmation prompt that describes the consequences.

edit: tracking confirmation in #289

@chikoski
Copy link
Author

Thanks for sharing the context.

Do you think it should be renamed? Or just requires clearer description and messaging in the CLI?

I believe the subcommand requires more clearer description in the help messages, at least.

As for the changing name, the following words popped up in my mind:

  • revoke
  • disable
  • drop
  • deactivate

@dfoxfranke
Copy link
Contributor

I hate to introduce yet another new term rather than just use the same one as other languages' registries, even if it's imperfect. But if we must, then how about "retract"?

calvinrp added a commit that referenced this issue May 15, 2024
- added a client method `sign_with_keyring_and_publish` ("keyring"
feature required), making it easier for other crates that use the
`warg-client` enable publishing
- when `warg publish yank`, adds a confirmation and more description
#289 #264
@calvinrp
Copy link
Collaborator

In #290 PR, added a confirmation message that defaults to no

`Yank` revokes a version, making it unavailable. It is permanent and cannot be reversed.
Yank `{version}` of `{package}`?

Not sure that this fully resolves this issue, but hopefully an improvement.

@lann
Copy link
Collaborator

lann commented May 22, 2024

Another reference: https://pypi.org/help/#yanked

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

No branches or pull requests

4 participants