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

Documentation Issue: Verify Parameter Naming Consistency (camelCase Only) #590

Open
NewtTheWolf opened this issue Nov 12, 2024 · 0 comments

Comments

@NewtTheWolf
Copy link
Contributor

Summary

The documentation currently specifies using snake_case for configuration parameters (e.g., max_tokens), but it appears that only camelCase may work in practice. This discrepancy could cause confusion and errors for users.

Proposed Action

  • Verify if all configuration parameters only work with camelCase (e.g., maxTokens instead of max_tokens).
  • Update the documentation to clearly indicate the correct naming convention, ensuring all examples and descriptions use camelCase.

Additional Notes

If camelCase is indeed the only supported format, updating the documentation to reflect this would reduce potential confusion, prevent configuration errors, and align with general coding conventions.

Thank you for addressing this documentation issue!

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

No branches or pull requests

1 participant