make sure that the LB Data JSON examples are always up to date in documentation - Githubissues

DARMA-tasking / vt

DARMA/vt => Virtual Transport

Other

33 stars 8 forks source link

make sure that the LB Data JSON examples are always up to date in documentation #2291

Open cz4rs opened 1 month ago

cz4rs commented 1 month ago

A follow up to #2124 to avoid docs getting out of sync again. This should also help catching any accidental changes in the generated files.

What Needs to be Done?

add a reference LB Data JSON file
add a unit test / example that will generate LB Data JSON file and compare it with the reference
make sure that the example is checked with schema validator
embed the reference JSON file in vt/docs/node_lb_data.md
make sure the JSON Python validator stays up to date also by including the segment of code