Revise code block guidelines, add wkls #89
Conversation
This file contains hidden or 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
Contributor
pettiross
commented
Sep 30, 2025
pettiross
commented
- Updated guidelines for writing about code blocks.
- Added instructions for thumbnail images and wkls.
Updated guidelines for writing about code blocks. Added instructions for thumbnail images and wkls.
|
Review these changes at https://app.gitnotebooks.com/wherobots/wherobots-examples/pull/89 |
RoboDonut
reviewed
Oct 15, 2025
| - If needed, follow with a markdown cell with explanation of how the code works. | ||
| - Precede most code cells with with a markdown cell with a `##` H2 or `###` H3 headline to facilitate rapid scanning. | ||
| - Do include a brief description for new topics. Don't describe anything covered in the Getting Started notebooks (e.g. getting the `sedona` context). | ||
| - In general, write about code above it rather than below it. |
There was a problem hiding this comment.
Lets make this a stronger statement. "Describe the code block before (above) the code block. use comments to call out specific interesting parameters or functions"
RoboDonut
approved these changes
Oct 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.