Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

🐛 Fix options key present with parts during JB 1 upgrade #1799

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

🐛 Fix options key present with parts during JB 1 upgrade #1799

wants to merge 3 commits into from

Conversation

bryanwweber
Copy link

  • typo: fix numberted -> numbered in TOCTreeOptions
  • fix: allow options key in toc with parts

Closes #1796

@bryanwweber
typo: fix numberted -> numbered in TOCTreeOptions
3d408df
@bryanwweber
fix: allow options key in toc with parts
62b7d5d 
In JB 1, including the top-level options key with parts has no effect.
However, it doesn't throw an error in JB 1, so we prefer to remove it
and warn rather than erroring.
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jan 22, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: 4900155

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

rowanc1
rowanc1 reviewed Jan 22, 2025
View reviewed changes
packages/myst-cli/src/init/jupyter-book/toc.ts
numberted: z.boolean(),
numbered: z.boolean(),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brilliant catch!

@rowanc1 rowanc1 changed the title 🐛 Fix options key present with parts during JB 1 upgrade 🐛 Fix options key present with parts during JB 1 upgrade Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@agoose77 agoose77 agoose77 left review comments

@rowanc1 rowanc1 rowanc1 left review comments

Assignees

@agoose77 agoose77

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

options in Jupyter Book TOC fails upgrade
3 participants
@bryanwweber @rowanc1 @agoose77