component v2 Docs #82
Conversation
There was a problem hiding this comment.
Some of your codeblocks containing custom command code are currently using the go highlighting--please use our custom yag highlighting.
Please also observe the linter annotations; in summary your headers and fenced codeblocks should be surrounded by blank lines. We're not linting the functions page for $reasons, but those rules apply there, too.
|
I'm gonna give this a proper look later today, I currently am preoccupied with something else. Thanks in advance for the work! |
There was a problem hiding this comment.
Thank you for the PR and your patience with our linter; I have left some review comments on specific parts.
In general your custom command code formatting is a little inconsistent; sometimes, you write {{action}}, then {{ action }}, or combinations thereof like {{ action}}. Please format all your custom command code to {{ action }} for easier readability.
While you're at that, please also then take a subsequent look at your indentations: if it looks weird, e.g. because you've got a ) }} on a single line, consider something like
{{ $s := someFunc params (
...
)
}}
|
I did not know that i have to click merge button again 🥲 |
added blank lines around headers and code blocks (lint fix) and used absolute link to link the file fixed more linter errors, no more linter errors now hopefully fixed all linter errors, finally v2 added all suggestion, and fixed all corrections, simplified the example with proper syntax reference/cv2: minor formatting Signed-off-by: Luca Zeuch <[email protected]>
|
FYI I've also gone ahead and squashed the changes into one commit—I don't think keeping the entire history here is that necessary, the main work stems from the initial commit. |
Added the component V2 functions and examples in the docs
Terms