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

Support binding documentation in config files #1747

Open
mwestphal opened this issue Dec 3, 2024 · 0 comments
Open

Support binding documentation in config files #1747

mwestphal opened this issue Dec 3, 2024 · 0 comments
Labels
help wanted Please help with this issue! source:F3DApplication source:libf3d type:enhancement New feature or request
Milestone

Comments

@mwestphal
Copy link
Contributor

mwestphal commented Dec 3, 2024

Is your feature request related to a problem? Please describe.
F3D supports configuring bindings in config files, but there is no documentation logic, leading to partial support in the cheatsheet display, especially when using multiple commands.

Lets add proper support for documenting user bindings, including support for displaying values.

Suggested Solution

  • Add support for generating strings out of options in utils::string_template using options API
  • Add anoter method to bindings API to be able that can use this templating mechanism
  • Design a json syntax to add documentation and template-based value in user configs
  • Recover the doc info in F3DConfigFileTools and use the new bidings API
  • Add tests
@mwestphal mwestphal added type:enhancement New feature or request source:libf3d help wanted Please help with this issue! source:F3DApplication labels Dec 3, 2024
@mwestphal mwestphal added this to F3D Dec 3, 2024
@mwestphal mwestphal moved this to Investigate in F3D Dec 3, 2024
@mwestphal mwestphal added this to the 3.1.0 milestone Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Please help with this issue! source:F3DApplication source:libf3d type:enhancement New feature or request
Projects
Status: Investigate
Development

No branches or pull requests

1 participant