docs: fix documentation formatting in IPermit3#57
Merged
re1ro merged 2 commits intofeat/permit-treefrom Nov 22, 2025
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR corrects documentation formatting issues in the IPermit3 interface to ensure parameter documentation matches the actual struct field definitions. The changes address inconsistencies between documented parameter names and field order versus the actual struct implementations.
- Fixed parameter name from 'levels' to 'nodes' in PermitNode struct documentation
- Reordered @param documentation in PermitTree to match struct field declaration order
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Address PR feedback:
Changes: