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

Provide documentation for procedural macros in scylla-udf-macros, not scylla-udf #14

Open
piodul opened this issue May 12, 2023 · 0 comments

Comments

@piodul
Copy link
Collaborator

piodul commented May 12, 2023

Currently, the project has two crates: scylla-udf and scylla-udf-macros. The latter defines procedural macros that use some items from the first one, and also the former re-exports the macros defined in the latter. Due to that, we thought that it's impossible to provide doctests in the scylla-udf-macros crate: we would have to import scylla-udf in scylla-udf-macros, which would cause an import cycle.

However, it appears that it's possible for scylla-udf-macros to have a dev-dependency on scylla-udf - meaning that the test binary for scylla-udf-macros depends on scylla-udf, but not the crate itself. The procedural macros are not documented in scylla-udf-macros, but we could easily fix that by introducing the dev-dependency and moving the docstrings to the crate where the macros are defined.

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

1 participant