feat: ✨ output everything from code cells in Reference docs #997
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
Based on the work by @martonvago in 498e1b9.
… to `dict` internally
So the examples will run correctly. If `create_resource_properties` is run before `create_resource_structure` the example will fail bc the resource structure doesn't exist yet.
There's no output of this code chunk, so it's not needed.
By moving `write_resource_properties` down.
This adds a yml header with the setting`ipynb-shell-interactivity: all` to get all output from example cells in the reference docs.
When we have added `ipynb-shell-interactivity: all` at the top of the document.
Base automatically changed from
docs/add-examples-to-user-facing-functions
to
main
January 24, 2025 14:13
lwjohnst86
approved these changes
Jan 24, 2025
lwjohnst86
deleted the
feat/output-everythin-in-reference-docs-examples
branch
|
Jumped the gun here. This shouldn't be a |
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
This PR adds the setting
ipynb-shell-interactivity: allin a yml header in all Reference docs.This ensures that all output from the cell is printed below it.
It also makes the
output: truesetting in all example cells redundant.This PR needs a quick review.
Checklist
just run-all