fix: library cleanup — dead links, notebook structure, report notebook#4
Merged
Conversation
Phase 1: Quick fixes - Fix 4 dead links (tutorial.html → benchmark.html, remove sensitivity.html) - Fix bare except: → except Exception: in profiling hooks - Remove unused import Any in compute Phase 2: Notebook structure (all 10 API notebooks) - Add raw YAML frontmatter, show_doc, setup cells, tests, See Also Phase 3: Report - Recreate analysis/report.ipynb from report.py (source was missing) - Add report tutorial with compression workflow - Add both to _quarto.yml sidebar
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
Supersedes #3 (rebased on post-v0.1.0 master).
Phase 1: Quick fixes
tutorial.html→benchmark.html, removesensitivity.htmlrefs)except:→except Exception:in profiling hooksfrom typing import Anyin computePhase 2: Notebook structure (all 10 API notebooks)
#| include: falsesetup cellsshow_doc()for all public classes/functions#| hidetest cells withfastcore.testPhase 3: Report
analysis/report.ipynbfromreport.py(source notebook was missing)_quarto.ymlsidebarTest plan
nbdev-testfull suite passesnbdev-export+nbdev-cleanproduce clean checkout