Skip to content

Conversation

mkundu1
Copy link
Contributor

@mkundu1 mkundu1 commented May 9, 2022

No description provided.

],
"default": "3d",
"required": true,
"fluent_required": true,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:-). OK, so it means that Fluent requires that this argument be included onto the command line.

Can you put comments in a json file? Maybe document each entry at the top?

Copy link
Contributor Author

@mkundu1 mkundu1 May 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, all fields starting within "fluent_" are fluent-specific in the json.

The json format doesn't have a syntax for adding comments. If we need to add comments, we need to add a field named "comment". Alternatively, the json can be replaced with yaml or toml which supports inline comments (Python 3.11 will natively support toml - link).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Mainak. Makes sense.

Copy link
Collaborator

@dnwillia-work dnwillia-work left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. If it's possible to document the json content that would be great.

@mkundu1 mkundu1 merged commit 7f505da into main May 10, 2022
@mkundu1 mkundu1 deleted the doc/launch_fluent branch May 10, 2022 12:08
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

Successfully merging this pull request may close these issues.

launch_fluent doc suggestions json content a bit confusing

4 participants