Refactor and test examples #26
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timkpaine
added
the
part: documentation
timkpaine
force-pushed
the
tkp/examples
branch
from
1bf3700
to
30b6d1d
Compare
4 tasks
timkpaine
force-pushed
the
tkp/examples
branch
from
30b6d1d
to
6b90b42
Compare
ngoldbaum
reviewed
Feb 13, 2024
There was a problem hiding this comment.
ping @pavithraes - does the reorganization of the examples makes sense to you?
Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
timkpaine
force-pushed
the
tkp/examples
branch
from
6b90b42
to
dda1ec7
Compare
Yes, looks good to me :) |
ngoldbaum
approved these changes
Feb 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is the start of a refactoring of our examples.
Previously, our examples were just a collection of python scripts with inline comments. In this PR, we'll start moving some commentary to markdown, where we can show richer outputs and have easier long-form explanations.
Our examples also tend to bit rot, so as far as is possible, we'll normalize the example format (e.g. have a
mainfunction as the primary entry point) and add tests (e.g. call thismain) so that we can better ensure our examples stay up to date.ref: #11 and #15