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

Add documentation for writing Rainfly examples #404

Open
mjwilson-google opened this issue Oct 22, 2024 · 0 comments
Open

Add documentation for writing Rainfly examples #404

mjwilson-google opened this issue Oct 22, 2024 · 0 comments

Comments

@mjwilson-google
Copy link
Collaborator

This came up in review here.

Rainfly examples at the time of writing take a samplerate parameter as follows:
// @paramName = <value>

But it's not documented anywhere that these comments are parsed and used as parameters. We should document it somewhere, some possibilities are:

  • README file
  • GitHub Wiki
  • HELP dropdown in the Rainfly UI
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