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

Remove Overridden Question Attributes in Documentation #2513

Merged

Conversation

luminousleek
Copy link
Contributor

@luminousleek luminousleek commented Apr 10, 2024

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • DevOps
  • Improve developer experience
  • Others, please explain:

Fixes #2512
Related to #2511

Overview of changes:

Remove header and hint attributes in question with header and hint slots.

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 header and hint attributes.

Testing instructions:

Switch to the branch for PR #2511, navigate to the docs directory and run markbind serve -d. Logger warnings should appear. Then, make the changes in this PR, and run markbind serve-d again. There should not be logger warnings anymore.

Proposed commit message: (wrap lines at 72 characters)

Remove Overridden Question Attributes in Docs

The docs currently has a question where there are slots overriding
the header attributes. However, when #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.

Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

Reviewer checklist:

Indicate the SEMVER impact of the PR:

  • Major (when you make incompatible API changes)
  • Minor (when you add functionality in a backward compatible manner)
  • Patch (when you make backward compatible bug fixes)

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):

  • To be included in the release note for any feature that is made obsolete/breaking

Give a brief explanation note about:

  • what was the old feature that was made obsolete
  • any replacement feature (if any), and
  • how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

Copy link
Contributor

@kaixin-hc kaixin-hc left a comment

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

@yucheng11122017 yucheng11122017 left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for the detailed catch

@kaixin-hc kaixin-hc merged commit 574e800 into MarkBind:master Apr 12, 2024
7 checks passed
Copy link

@kaixin-hc Each PR must have a SEMVER impact label, please remember to label the PR properly.

@kaixin-hc kaixin-hc added the r.Patch Version resolver: increment by 0.0.1 label Apr 12, 2024
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
r.Patch Version resolver: increment by 0.0.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Overridden Attribute for Question in Documentation causes Logger Warnings and Build Failure
3 participants