Remove Overridden Question Attributes in Documentation#2513
Merged
kaixin-hc merged 1 commit intoApr 12, 2024
Conversation
kaixin-hc
approved these changes
Apr 10, 2024
kaixin-hc
left a comment
Contributor
There was a problem hiding this comment.
Thanks for this catch!
FYI, each PR has a netlify deploy of the docs. So to test this you can actually just check this PR's deploy vs the original deployment.
yucheng11122017
approved these changes
Apr 12, 2024
yucheng11122017
left a comment
Contributor
There was a problem hiding this comment.
LGTM! Thanks for the detailed catch
|
@kaixin-hc Each PR must have a SEMVER impact label, please remember to label the PR properly. |
Tim-Siu
pushed a commit
to Tim-Siu/markbind
that referenced
this pull request
Apr 12, 2024
The docs currently has a question where there are slots overriding the header attributes. However, when MarkBind#2511 is merged, logger warnings about this overriding will be triggered, leading to the check-docs GitHub action failing. Let's remove the header attributes so that they will not trigger the logger warning. Let's also update the sample code to reflect this change.
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.
What is the purpose of this pull request?
Fixes #2512
Related to #2511
Overview of changes:
Remove
headerandhintattributes in question withheaderandhintslots.Anything you'd like to highlight/discuss:
The page on the User Guide in question is this. Expand the panel entitled Header and Hint example with slots.
This still achieves the purpose of the documentation, which is to show how slots can replace the
headerandhintattributes.Testing instructions:
Switch to the branch for PR #2511, navigate to the
docsdirectory and runmarkbind serve -d. Logger warnings should appear. Then, make the changes in this PR, and runmarkbind serve-dagain. There should not be logger warnings anymore.Proposed commit message: (wrap lines at 72 characters)
Checklist: ☑️
Reviewer checklist:
Indicate the SEMVER impact of the PR:
At the end of the review, please label the PR with the appropriate label:
r.Major,r.Minor,r.Patch.Breaking change release note preparation (if applicable):