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

Continue docstring after newline #36

Merged
merged 2 commits into from
Mar 1, 2022
Merged

Conversation

antifuchs
Copy link
Contributor

This fixes #35 and adds a test to ensure that it is/stays fixed (-:

Copy link
Member

@clux clux left a comment

Choose a reason for hiding this comment

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

Minor comment, but looks great

src/main.rs Outdated Show resolved Hide resolved
justfile Show resolved Hide resolved
@antifuchs
Copy link
Contributor Author

Updated!

@clux
Copy link
Member

clux commented Feb 25, 2022

Thanks a lot. Before I can merge, are you able to --signoff your commits as per the DCO check? Legal requirements.

This uses the cert-manager 1.7.1 CRDs and is the only test that uses
--docs, so far.

Signed-off-by: Andreas Fuchs <asf@materialize.com>
If the documentation of a resource includes newlines, we must add a
new /// marker after that newline, otherwise the code generation
yields a syntax error.

This is pretty naive, but effective: The docs that are generated
are correctly indented and result in files that compile.

Signed-off-by: Andreas Fuchs <asf@materialize.com>
@antifuchs
Copy link
Contributor Author

Re-done with sign-off!

@clux
Copy link
Member

clux commented Mar 1, 2022

Thanks a lot!

@clux clux merged commit c74379d into kube-rs:main Mar 1, 2022
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.

Generates doc comments that result in syntax errors
2 participants