Skip to content

🔧 Refactorings to clean up table-of-contents transform #2181

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

brianhawthorne
Copy link
Contributor

A handful of refactorings to toc.ts module in myst-transforms:

  • Extract snippets for creating List and ListItem type objects into two little helper functions.
  • Extract the base cases of the two mutually recursive function pairs into separate dedicated transform functions to help make the almost exactly identical structure of those two function pairs more apparent.
  • Break up the three distinct sub-parts of the main function into three separate sub-functions to make the overall functionality and control flow more apparent.
  • Add a few explanatory comments.

Hopefully these changes will make this module a bit more accessible to newcomers.

Copy link

changeset-bot bot commented Jul 18, 2025

⚠️ No Changeset found

Latest commit: 6181767

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant