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.

Sign up for GitHub

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

Jump to bottom

[Documentation] Add doc-tests to test workflow to guarantee working examples #266

Open
sea212 opened this issue Aug 13, 2021 · 0 comments
Open

[Documentation] Add doc-tests to test workflow to guarantee working examples #266

sea212 opened this issue Aug 13, 2021 · 0 comments
Labels
p:low Low priority, resolution of this issue can wait t:enhancement The issue described an enhancement

Comments

@sea212
Copy link
Member

sea212 commented Aug 13, 2021

When tests are executed, doc-tests for that crate should also be executed. Extended the test job in the associated workflow, such that it will also respect the doc-tests. This can save developers a lot of nerves when trying out our libraries by coping & pasting our examples, since our pipeline will fail when the doc-tests fails and consequently force us to fix the underlying examples.

depends on #265
@sea212 sea212 added p:low Low priority, resolution of this issue can wait t:enhancement The issue described an enhancement labels Aug 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
p:low Low priority, resolution of this issue can wait t:enhancement The issue described an enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sea212