docs: add common errors troubleshooting tutorial - #22
Open
timtreis wants to merge 2 commits into
Open
Conversation
New tutorials/common_errors.ipynb turning spatialdata-plot's up-front input validation (0.4.0 hardening) into a troubleshooting reference. Each section triggers a common error via try/except on the blobs dataset, prints the exact message, and gives the one-line fix: - element not found (KeyError) - colouring by a column with no annotating table (KeyError) - invalid image channel (ValueError, lists valid channels) - wrong-length per-channel norm list (ValueError) - grayscale requires exactly 3 channels (ValueError) - invalid PercentileNormalize bounds (ValueError) Executed against spatialdata-plot v0.4.1; committed with outputs. Adds the gallery card + toctree + a terminal-style thumbnail. Closes P3 of the doc-coverage analysis.
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
📖 Docs preview: https://scverse.org/spatialdata-plot-tutorials/pr-22/gallery.html Built from 6b06016; redeployed on every push. |
…uous colour/column cases, annotate percentile-bound rules
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds
tutorials/common_errors.ipynb— a troubleshooting reference that turnsspatialdata-plot's up-front input validation (the 0.4.0 error-hardening work) into a learnable page. Each section triggers a common error viatry/exceptonblobs, prints the exact message, and gives the one-line fix.Covers:
KeyError)KeyError)ValueError, which lists the valid channels)normlist (ValueError)grayscalerequires exactly 3 channels (ValueError)PercentileNormalizebounds (ValueError)Executed against spatialdata-plot v0.4.1, committed with outputs. Adds the gallery card + toctree + a terminal-style thumbnail.
Final notebook of the documentation-expansion series from the 0.4.0/0.4.1 gap analysis (P3).