Improved docs for NDSL examples #63
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
romanc
force-pushed
the
feature/better-docs-for-ndsl-examples
branch
2 times, most recently
from
bb539e5
to
97ee945
Compare
added 3 commits
August 6, 2024 12:41
- Use boilerplate from ndsl.boilerplate - Fix typos & broken links in notebooks - Added README with quickstart guide
romanc
force-pushed
the
feature/better-docs-for-ndsl-examples
branch
from
97ee945
to
8c6b4e0
Compare
FlorianDeconinck
requested changes
Aug 6, 2024
romanc
changed the title
For some reason, this file was had the executable flag, marking it an executable under linux-based filesystem. Since notebooks aren't directly executed and rather read by Jupyter (or whatever platform), this is unnecessary. Other notebooks didn't have the executable flag (which is what I would expect).
|
Sorry, for yet another commit. Just realized that one of the notebooks was marked as executable
|
FlorianDeconinck
approved these changes
Aug 7, 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.
Description
Tutorials are in important step in on-boarding new library users. While working through the examples, I noticed a couple of typos and broken links. In the bigger picture, we figured that examples should use the boilerplate code that the middleware already exposes in
ndsl.boilerplate. I've also added a README file with a little bit of context and a quickstart guide to get people up and running with minimal overhead. And we agreed to remove the output currently stored in the Jupyter notebooks. This was one in the first commit such that we can see the actual changes when looking at the other commits.In summary
plot_filed_at_kNfromexamples/NDSL/basic_boilerplate.pytondsl/boilerplate.py. This addsmatplotlibto the list of dependnecies.ndsl.boilerplate.examples/NDSL/*_boilerplate.pyexamples/NDSL/README.mdwith a bit of context.It is recommended to exclude the first commit when looking at the diff, e.g. this view is much nicer to look at.
Regarding the previous addition of a
.tool-versionsfile a python version manager: With the install instructions as simple aspip install ndsl[demos], I don't think we need this complexity anymore. The middleware's README already specifies the need for python 3.11. How developers ensure this should be up to them.Fixes: N/A
How Has This Been Tested?
I ran all the notebooks locally against a local version of NDSL.
Checklist: