fix: Omit private methods from doc ToC#275
Merged
tomasz-blasz merged 1 commit intonextfrom Sep 15, 2025
Merged
Conversation
tomasz-blasz
approved these changes
Sep 12, 2025
Contributor
tomasz-blasz
left a comment
tomasz-blasz
left a comment
There was a problem hiding this comment.
Looks fine to me, but I'd like @vladimir-rangelov to review it before we merge.
vladimir-rangelov
approved these changes
Sep 12, 2025
aczs
pushed a commit
that referenced
this pull request
Sep 15, 2025
# [3.2.0-next.18](v3.2.0-next.17...v3.2.0-next.18) (2025-09-15) ### Bug Fixes * Omit private methods from doc ToC ([#275](#275)) ([296a066](296a066))
Collaborator
|
🎉 This PR is included in version 3.2.0-next.18 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
4 participants
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.
The documentation portal has an issue where HTML tags are being escaped/not properly handled by Jekyll. I don't think this is an issue with Jekyll, but rather in how we're mixing markdown with HTML in a non-standard way (this wasn't tested against the Comcast doc portal yet).
This mainly affects the private methods/events, which were intended to be "hidden" behind a dropdown in the Table of Contents.e.g.:
This changes updates the logic to remove the hidden methods/broken HTML, and instead replace it with a link to the private methods/events section.