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

Fix docs for Target.kind and Target.crate_types #255

Merged
merged 6 commits into from Nov 19, 2023

Conversation

Shnatsel
Copy link
Contributor

I only realized that far more values than documented are possible in the Target.kind fields after my code broke for end users.

This brings the crate doc commends in line with the official documentation on cargo metadata.

The docs for kind are based on both the cargo metadata documentation and my experiments, while the docs for crate_types are based on documentation alone.

Copy link

@jplatte jplatte left a comment

Choose a reason for hiding this comment

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

(not a maintainer)

There should probably be a newline in the docs between the first sentence and the rest for both fields (so that it renders as two paragraphs).

@oli-obk
Copy link
Owner

oli-obk commented Nov 16, 2023

We should probably make these a non_exhaustive enum.

For now, please also document that new variants may get added at any time

@Shnatsel
Copy link
Contributor Author

Yes, I agree that an enum would be better. But that would break semver, and I wanted to start with a less invasive change.

@Shnatsel
Copy link
Contributor Author

I've addressed all review feedback, PTAL.

@oli-obk oli-obk merged commit 755dcac into oli-obk:main Nov 19, 2023
6 checks passed
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.

None yet

3 participants