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.

Sign up for GitHub

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

Jump to bottom

Validation Script for OC Path and RPC Coverage in READMEs #2865

Merged
merged 19 commits into from
Apr 8, 2024
Merged

Validation Script for OC Path and RPC Coverage in READMEs #2865

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
6632935
Add yaml spec for oc path/rpc to test-requirements-template
dplore Mar 28, 2024
7329e95
revise yaml
dplore Mar 28, 2024
e5a0e45
revise yaml
dplore Mar 28, 2024
9f57dbc
Validation Script for OC Path and RPC Coverage in READMEs
wenovus Mar 30, 2024
2515f36
Add invalid README example
wenovus Mar 30, 2024
890d3f2
Fix style
wenovus Mar 30, 2024
93bc9bd
Make YAMLRenderer unexported
wenovus Apr 2, 2024
5ee1b4c
Improve comments
wenovus Apr 4, 2024
d6e80be
Merge branch 'main' into mdocspec
wenovus Apr 5, 2024
04b2b0c
Update tools/internal/mdocspec/ocspec.go
wenovus Apr 5, 2024
18658b9
Merge branch 'mdocspec' of github.com:openconfig/featureprofiles into…
wenovus Apr 5, 2024
08f5448
Minor improvements for OC coverage validation
wenovus Apr 5, 2024
5826fd9
Improve logic by searching from header rather than YAML block
wenovus Apr 5, 2024
9a1ffc5
add another corner case test
wenovus Apr 5, 2024
b0515e0
add another corner case test
wenovus Apr 5, 2024
218ea66
Improve doc comment
wenovus Apr 6, 2024
73d317c
Improve doc comments
wenovus Apr 8, 2024
1f5be99
Fix doc comment
wenovus Apr 8, 2024
2b79d7b
Merge branch 'main' into mdocspec
wenovus Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Make YAMLRenderer unexported
  • Loading branch information
@wenovus
wenovus committed Apr 2, 2024
commit 93bc9bd2853020e1f85b433c2a70f7b47addfed8
12 changes: 6 additions & 6 deletions tools/internal/mdocspec/md.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,18 @@ var MDOCSpecs = &mdOCSpecs{}

func (e *mdOCSpecs) Extend(m goldmark.Markdown) {
extension.GFM.Extend(m)
m.SetRenderer(&YAMLRenderer{})
m.SetRenderer(&yamlRenderer{})
}

type YAMLRenderer struct{}
type yamlRenderer struct{}

func (r *YAMLRenderer) Render(w io.Writer, source []byte, n ast.Node) error {
func (r *yamlRenderer) Render(w io.Writer, source []byte, n ast.Node) error {
return ast.Walk(n, func(n ast.Node, entering bool) (ast.WalkStatus, error) {
return yamlRenderer(w, source, n, entering)
return renderYAML(w, source, n, entering)
})
}

func (r *YAMLRenderer) AddOptions(...renderer.Option) {}
func (r *yamlRenderer) AddOptions(...renderer.Option) {}

func yamlCodeBlock(source []byte, n ast.Node) *ast.FencedCodeBlock {
if s, ok := n.(*ast.FencedCodeBlock); ok && s.Info != nil {
Expand All @@ -50,7 +50,7 @@ func yamlCodeBlock(source []byte, n ast.Node) *ast.FencedCodeBlock {
return nil
}

func yamlRenderer(w io.Writer, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error) {
func renderYAML(w io.Writer, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error) {
if !entering {
return ast.WalkContinue, nil
}
Expand Down
Loading