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.

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

✏️ Rename Toc -> TOC #1177

Merged
merged 2 commits into from
May 3, 2024
Merged

✏️ Rename Toc -> TOC #1177

merged 2 commits into from
May 3, 2024

Conversation

agoose77
Copy link
Collaborator

@agoose77 agoose77 commented May 1, 2024

This is a clean-up PR, before we start doing surgery on TOC handling.

@rowanc1 rowanc1 requested a review from fwkoch May 1, 2024 15:00
@agoose77 agoose77 force-pushed the agoose77/refactor-rename-toc branch from eb6eab3 to 7d589d7 Compare May 1, 2024 15:15
@agoose77 agoose77 changed the title refactor: rename Toc -> TOC ✏️: rename Toc -> TOC May 1, 2024
@agoose77 agoose77 changed the title ✏️: rename Toc -> TOC ✏️ Rename Toc -> TOC May 1, 2024
Copy link
Member

@fwkoch fwkoch left a comment

Choose a reason for hiding this comment

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

I don't feel super strongly about this - the naming consistency is nice; the breaking change is not so nice. However, if we are making these changes sometime, sooner is better than later!

@@ -0,0 +1,7 @@
---
"myst-common": minor
"myst-cli": minor
Copy link
Member

Choose a reason for hiding this comment

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

I think this is the most notable part of this PR - making a breaking change for some naming consistency.

@agoose77
Copy link
Collaborator Author

agoose77 commented May 3, 2024

Thanks Franklin! I'm taking that as merge approval :D

@agoose77 agoose77 merged commit 7a04910 into main May 3, 2024
5 checks passed
@agoose77 agoose77 deleted the agoose77/refactor-rename-toc branch May 3, 2024 09:13
@rowanc1
Copy link
Member

rowanc1 commented May 7, 2024

@agoose77 bug I found:

myst init --write-toc

no longer works.

Will make a patch in #1182.

@agoose77 agoose77 self-assigned this May 7, 2024
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.

None yet

3 participants