move to use "conduit_yaml" in docs
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 248
- Forks
- 72
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 15
Description
Audit examples and change to use yaml output for schema details in examples.
We need "conduit_yaml" rep that includes details to replace the "conduit_json" output.
Also, "conduit_json" formatting is a little strange here:
```
"x":
{
"dtype":"float64",
"number_of_elements": 5,
"offset": 0,
"stride": 24,
"element_bytes": 8,
"endianness": "little"
, "value": [1.0, 1.0, 1.0, 1.0, 1.0]},
"y":
{
"dtype":"float64",
"number_of_elements": 5,
"offset": 8,
"stride": 24,
"element_bytes": 8,
"endianness": "little"
, "value": [2.0, 2.0, 2.0, 2.0, 2.0]},
"z":
{
"dtype":"float64",
"number_of_elements": 5,
"offset": 16,
"stride": 24,
"element_bytes": 8,
"endianness": "little"
, "value": [3.0, 3.0, 3.0, 3.0, 3.0]}
}
```
The logic that fuses the schema details with the values needs to be adjusted.
(from https://llnl-conduit.readthedocs.io/en/latest/blueprint.html#top-level-blueprint-interface)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Blueprint documentation and locate the examples that currently use conduit_json for schema details. Audit those examples against the requested conduit_yaml output, then verify that the schema details and values are fused and formatted correctly; done means the examples consistently use the intended YAML representation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json, yaml
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100