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

Consider including parts of the solution instead of copy pasting to the markdown file #23

Closed
bjoernQ opened this issue Nov 14, 2023 · 0 comments · Fixed by #24
Closed
Assignees

Comments

@bjoernQ
Copy link
Contributor

bjoernQ commented Nov 14, 2023

It might be better to use https://rust-lang.github.io/mdBook/format/mdbook.html#including-portions-of-a-file (especially with anchors) instead of copy-pasting code.

That way we could make sure that what is written in the book is always in sync with the actual code and we can make sure the code snippets are correct (since we check them in CI).

Only drawback I see when doing this: the ANCHOR comments in Rust source files might look a bit confusing - but we could explain that in the introduction

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants