Mentioning the limitations of YAML files in the docs - Githubissues

terrapower / armi

An open-source nuclear reactor analysis automation framework that helps design teams increase efficiency and quality

https://terrapower.github.io/armi/

Apache License 2.0

224 stars 87 forks source link

Mentioning the limitations of YAML files in the docs #1668

Closed john-science closed 5 months ago

john-science commented 6 months ago

What is the change?

This is a small change to the docs where I explicitly mention the "duplicate keys" limitation of YAML files.

Also, and I'm sorry about this, I did a tiny bit of cleanup in the docs; mostly whitespace.

Why is the change being made?

After much trial-and-error, it doesn't appear reasonable that we will build our own YAML reader to close #433.

Checklist

[X] This PR has only one purpose or idea.
[X] Tests have been added/updated to verify any new/changed code.

[X] The code style follows good practices.
[X] The commit message(s) follow good practices.

[X] The release notes have been updated if necessary.
[X] The documentation is still up-to-date in the doc folder.
[X] The dependencies are still up-to-date in pyproject.toml.

john-science commented 6 months ago

Bump