Skip to content
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

Improve the documentation about extending the parser for k4run #269

Merged
merged 3 commits into from
Jan 24, 2025

Conversation

jmcarcell
Copy link
Member

BEGINRELEASENOTES

  • Improve the documentation about extending the parser for k4run

ENDRELEASENOTES

Some minor syntax changes and a comment about the [0] that I typically forget when writing from memory.

Copy link
Contributor

@m-fila m-fila left a comment

Choose a reason for hiding this comment

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

Could you also add usage example from cli? For instance something like

The example steering file can then be executed as follows:

k4run example_steering_file.py --trackingOnly --some-other-args 

@jmcarcell
Copy link
Member Author

Done

@jmcarcell jmcarcell force-pushed the k4run-docs branch 3 times, most recently from a8cd659 to 1f171fb Compare January 24, 2025 17:41
@jmcarcell jmcarcell enabled auto-merge (squash) January 24, 2025 17:41
@jmcarcell jmcarcell merged commit 099e0f4 into main Jan 24, 2025
7 of 9 checks passed
@jmcarcell jmcarcell deleted the k4run-docs branch January 24, 2025 17:44
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.

2 participants