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

Document default server config values #211

Open
lindhe opened this issue May 17, 2024 · 2 comments
Open

Document default server config values #211

lindhe opened this issue May 17, 2024 · 2 comments

Comments

@lindhe
Copy link

lindhe commented May 17, 2024

Many of the settings in server_config.md have no documented default value:

image

Would be amazing if this could be improved! I would be happy to help, but I don't know where to look to identify the default values.

@dereknola
Copy link
Member

If not documented, the defaults are the "default Golang values" of each type. So any boolean are false, any integers are 0, and any strings are empty "".

@lindhe
Copy link
Author

lindhe commented Jul 9, 2024

Thank you for explaining that!

Personally, I prefer explicitness in documentation. It makes it much easier for everyone to read, with no need for special knowledge or for people to make assumptions. Since the docs never mentions Golang, or which type the values are, I still think we should try and improve it. 🙂

Since you informed me of their defaults, I guess I should be able to make a PR now. Do you think that would be appreciated?

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

2 participants