docs: render __Contents__ blocks as Markdown lists#54
Merged
Conversation
Without bullet markers, GitHub and JupyterLab collapse the contents block into one paragraph in the generated notebook's first markdown cell. Prefixing each `**Section:**` line with `- ` makes it render as a list. Continuation lines are indented two spaces so they belong to the same list item. Text-only edit inside top-level module docstrings — no Python or notebook execution change. Refs: PyAutoLabs/autolens_workspace#138
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
Convert
__Contents__blocks at the top of workspace tutorial scripts' module docstrings from plain**Section:**lines into Markdown list bullets (- **Section:**).Without bullet markers, GitHub and JupyterLab collapse the contents block into one continuous paragraph in the generated notebook's first markdown cell. Prefixing each entry with
-makes it render as a list. Text-only change inside top-level module docstrings.Scripts Changed
1 script —
scripts/cookbooks/model.pyhad a single un-bulleted**Models:**heading inside its__Contents__block. Most of this repo's tutorial scripts were already bulleted (28 files); only this one needed the fix.Test Plan
Refs PyAutoLabs/autolens_workspace#138
🤖 Generated with Claude Code