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

Document crate-type lib requirement for generate-sources #174

Merged

Conversation

kriswuollett
Copy link
Contributor

- previously crate-type lib seemed optional
- fixes getditto#173
Copy link
Collaborator

@danielhenrymantilla danielhenrymantilla left a comment

Choose a reason for hiding this comment

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

Thanks for the submission! I'd just like to keep the mention to "rust dependents", but other than that the PR LGTM ✅

@@ -60,7 +60,7 @@ edition = "2021"
crate-type = [
"staticlib", # Ensure it gets compiled as a (static) C library
# "cdylib", # If you want a shared/dynamic C library (advanced)
"lib", # For downstream Rust dependents: `examples/`, `tests/` etc.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice to get it properly documented 🙏 although I do like the mention of downstream rust dependents as well, so I'd like to keep it.

What about:

    "lib",        # For `generate-headers` and other downstream rust dependents
                  # such as integration `tests/`, doctests, and `examples/`

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nice to get it properly documented 🙏 although I do like the mention of downstream rust dependents as well, so I'd like to keep it.

What about:

    "lib",        # For `generate-headers` and other downstream rust dependents
                  # such as integration `tests/`, doctests, and `examples/`

Sure, took your suggestion verbatim.

Copy link
Collaborator

@danielhenrymantilla danielhenrymantilla left a comment

Choose a reason for hiding this comment

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

Thanks!

@danielhenrymantilla danielhenrymantilla merged commit 5976546 into getditto:master Sep 4, 2023
@kriswuollett kriswuollett deleted the update-crate-type-docs branch September 5, 2023 16:28
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.

Quickstart crate-type lib seems documented too optional
2 participants