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

Code example in libcnb-test README doesn't work #403

Closed
edmorley opened this issue Jun 17, 2022 · 1 comment · Fixed by #433
Closed

Code example in libcnb-test README doesn't work #403

edmorley opened this issue Jun 17, 2022 · 1 comment · Fixed by #433
Labels
documentation Improvements or additions to documentation libcnb-test

Comments

@edmorley
Copy link
Member

After #366, this code example no longer works:
https://github.com/heroku/libcnb.rs/blob/e4e75c40816000312cfe56290a049d8df9dbb72b/libcnb-test/README.md#example

This was reported here:
#366 (comment)

We should both fix the example, and figure out why the testing of the code in that README isn't working:

// This runs the README.md as a doctest, ensuring the code examples in it are valid.
// It will not be part of the final crate.
#[cfg(doctest)]
#[doc = include_str!("../README.md")]
pub struct ReadmeDoctests;

(Maybe it's due to the [test] attribute used in the code example?)

@edmorley edmorley added documentation Improvements or additions to documentation libcnb-test labels Jun 17, 2022
@edmorley edmorley changed the title Code example in libcnb-test README does't work Code example in libcnb-test README doesn't work Jun 20, 2022
@Malax
Copy link
Member

Malax commented Jun 23, 2022

#422 fixes that the code is incorrect. No research has been done yet why the CI check doesn't work.

@edmorley edmorley linked a pull request Jun 24, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation libcnb-test
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants