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

The examples are not all runnable or documented #334

Open
Palmr opened this issue Nov 27, 2020 · 1 comment
Open

The examples are not all runnable or documented #334

Palmr opened this issue Nov 27, 2020 · 1 comment
Labels
documentation
Projects
4.0

Comments

@Palmr
Copy link
Member

Palmr commented Nov 27, 2020 •
edited

We should take a look at all the existing samples and see if they make sense, document them better and make sure they're using modern syntax.

We should remove a lot of the embedded code examples from the documentation and wiki, and instead be redirecting to code in the source. This stops code being left on the wiki to rot and become invalid when the source moves on.
@Palmr Palmr created this issue from a note in 4.0 (In progress) Nov 27, 2020
@Palmr
Copy link
Member Author

Palmr commented Nov 27, 2020

I have moved the examples to their own sourceset as of #333 given they were not tests so don't really live in the tests sourceset.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
4.0
In progress
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Palmr