T6342: add parsing of docs element #32
Open
+65
−0
Conversation
This file contains 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
12 tasks
jestabro
reviewed
Jan 10, 2025
Comment on lines
+203
to
+207
| in | ||
| match x with | ||
| | Xml.Element ("docs", _, children) -> | ||
| List.fold_left aux d children | ||
| | _ -> d |
There was a problem hiding this comment.
Suggested change
| in | |
| match x with | |
| | Xml.Element ("docs", _, children) -> | |
| List.fold_left aux d children | |
| | _ -> d | |
| in Xml.fold aux d x |
There was a problem hiding this comment.
Granted the documentation on Xml-light is sparse (contained in its .mli files), but Xml.fold will do the left fold over children and avoid the redundancy above.
| usageExample: string; | ||
| hints: doc_hints list; | ||
| } [@@deriving yojson] | ||
|
|
There was a problem hiding this comment.
We have not adopted strict formatting yet, but for the moment, I'd suggest consistency in the file: 4 space indent; closing brace aligned with start of definition.
| usageExample: string; | ||
| hints: doc_hints list; | ||
| } [@@deriving to_yojson] | ||
|
|
There was a problem hiding this comment.
Formatting, as mentioned above.
|
Looks good, Robert; suggestions above. Also, you may want to check for trailing whitespace on several lines. |
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.
Change Summary
Add support to parse
<docs>elements from xmlTypes of changes
Related Task(s)
Related PR(s)
vyos/vyos-1x#4292
Proposed changes
How to test
Checklist: