Skip to content

Clarify Inlet documentation #1538

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.

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

Open
adayton1 opened this issue Apr 3, 2025 · 0 comments
Open

Clarify Inlet documentation #1538

adayton1 opened this issue Apr 3, 2025 · 0 comments

Comments

@adayton1
Copy link
Member

adayton1 commented Apr 3, 2025

Can someone clarify the following statement from the documentation? What is meant by a runtime error? Are we talking an exception or something else?

"Accessing a value that was not provided by the user, or a default value, will result in a runtime error." (https://axom.readthedocs.io/en/develop/axom/inlet/docs/sphinx/simple_types.html#accessing)

I'm also confused about what happens if you have a container that is optional, but it has a field or container that is required. I assume that if the container is not specified in the user input, no error is thrown. But if the container is specified, then the required children must be specified or there will be an error.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant