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

C-METADATA: Change authors field to optional #266

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tobiasvl
Copy link

Per RFC 3052, the authors field in Cargo.toml is now optional, and this fact should be widely communicated.

See also:

@BurntSushi
Copy link
Member

It's not clear to me that our advice should change here. That it was marked optional doesn't mean we should stop recommending its use.

@tobiasvl
Copy link
Author

tobiasvl commented Aug 17, 2022

My intention was definitely not to stop recommending its use. I made sure to use the same phrasing as the one for documentation ("only needs to be set if...") instead of the stronger phrasing used for homepage ("should only be set if...").

The reason I included that it can still be used if the metadata is used directly by the crate was that it's the specific use case mentioned in RFC 3052.

Any suggestions on how to phrase it better?

@tobiasvl
Copy link
Author

Ah, now I think I understand what you're saying, sorry. I suppose the RFC became very crates.io-focused, and that the fact that it's optional for publishing to crates.io doesn't imply that it should be optional in the guidelines.

However, I guess the question then would be why the API guidelines should recommend its use? The RFC discussion uncovered several problems with it. Could we perhaps warn about them here? It should only be used if you want to tie authorship to a specific version, or something? I'm not sure.

What's the reason for recommending it?

@tshepang
Copy link
Member

It was probably recommended because it was required by crates.io at some point, so is just historical. I find your change an improvement (and a correction).

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 this pull request may close these issues.

3 participants