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

Include reference to currently supported constructs in our validation errors #15

Closed
wking opened this issue Jan 11, 2018 · 0 comments · Fixed by #17
Closed

Include reference to currently supported constructs in our validation errors #15

wking opened this issue Jan 11, 2018 · 0 comments · Fixed by #17

Comments

@wking
Copy link
Contributor

wking commented Jan 11, 2018

Currently, crates.io wraps our errors (e.g. here), which can result in confused users unless the references are specific. And if crates.io decided to include specific references (like Cargo grew in rust-lang/cargo#4898) we wouldn't be particularly DRY. I think this repository should clearly document what is supported and (optionally?) include a link to those docs in our error messages. We'd need to pin the link to a particular license-exprs release, but a message like:

unknown license or other term: NotInSPDX.  See https://github.com/rust-lang-nursery/license-exprs/blob/v1.4.0/README.md

would seem to cover rust-lang/cargo#3540 in a maintainable fashion. One we get clearer docs, we can update the Cargo docs to point at our docs as well, and then we'd be DRY. Thoughts?

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 a pull request may close this issue.

1 participant