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

Check code blocks for correct syntax #787

Open
tschmidtb51 opened this issue Sep 25, 2024 · 2 comments
Open

Check code blocks for correct syntax #787

tschmidtb51 opened this issue Sep 25, 2024 · 2 comments
Labels
csaf 2.1 csaf 2.1 work editorial mostly nits and consistency

Comments

@tschmidtb51
Copy link
Contributor

@mprpic found in #781 some incorrect brackets. We need to check all code blocks for the correct syntax and inconsistency.
@tschmidtb51 tschmidtb51 added editorial mostly nits and consistency csaf 2.1 csaf 2.1 work labels Sep 25, 2024
@tschmidtb51 tschmidtb51 changed the title Check code blocks for correct brackets Check code blocks for correct syntax Sep 25, 2024
tschmidtb51 added a commit to tschmidtb51/csaf that referenced this issue Sep 25, 2024
@tschmidtb51
Code block syntax
68562ef 
- addresses parts of oasis-tcs#787
- correct syntax for `product_identification_helper`
tschmidtb51 added a commit to tschmidtb51/csaf that referenced this issue Sep 25, 2024
@tschmidtb51 @mprpic
Code block syntax
a80538a 
- addresses parts of oasis-tcs#787
- correct syntax for `product_identification_helper`

Co-authored-by: Martin Prpič <[email protected]>
This was referenced Sep 25, 2024
Merged
Merged
@sthagen
Copy link
Contributor

sthagen commented Oct 4, 2024

As discussed during editor meeting today, the brackets were correct before (schema not instance), right?
My current position on verifying schema code blocks (with the comment ellipsis hacks to provide focus) is to visually inspect every time there is a change and to compare with the JSON Schema artifact source.

When verifying code blocks we must take the intended perspective, as there is JSON instance code and JSON Schema code.

@tschmidtb51
Copy link
Contributor Author

@sthagen We should discuss (and document) in our next meeting how we want to deal with indent and commas.

This was referenced Oct 25, 2024
Merged
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
csaf 2.1 csaf 2.1 work editorial mostly nits and consistency
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@sthagen @tschmidtb51