Repository navigation
FIX: Preserve user classes containing -start on gated directives - #93
Open
akashchamp wants to merge 1 commit into
Open
akashchamp wants to merge 1 commit into
akashchamp wants to merge 1 commit into
Conversation
MergeGatedExercises stripped "-start" from every class on the node and MergeGatedSolutions replaced "solution-start" anywhere in each class, so user classes such as quick-start were silently renamed. Map only the exact exercise-start / solution-start marker classes. Fixes executablebooks#90
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
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.
Fixes #90.
The gated merge transforms rewrote every class on the node:
MergeGatedExercisesdidcls.replace("-start", "")andMergeGatedSolutionsdidattr.replace("solution-start", "solution"), so a user:class: quick-startcame out asquick(andmy-solution-start-thingasmy-solution-thing). Now only the exactexercise-start/solution-startmarker class is mapped; everything else passes through unchanged.Added a small
gatedclassestest root andtest_gated_user_classes_preserved, which builds a gated exercise and a gated solution with-start-containing classes and checks the emittedclassattributes. It fails on main (exercise quick admonition,solution my-solution-thing admonition) and passes with the fix (exercise quick-start admonition,solution my-solution-start-thing admonition).Full suite passes locally (117 passed, Python 3.12, Sphinx 8.2.3) and pre-commit is clean on the changed files.