docs: add comment to annotate purpose of use_proxy option #285
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mryel00
reviewed
Jan 11, 2025
| @@ -32,7 +32,7 @@ | |||
| log_path: %LOGPATH% | |||
| log_level: verbose # Valid Options are quiet/verbose/debug | |||
| delete_log: false # Deletes log on every restart, if set to true | |||
| no_proxy: false | |||
| no_proxy: false # If true the server listen on all interfaces, not just localhost | |||
There was a problem hiding this comment.
I would use the same sentence structure as the comment directly above, e.g.:
Streamer listen on all interfaces, not just localhost, if set to true
The other possibility is to adjust the comment above as there are multiple comments starting with If in the cam section, e.g.:
If set to true, deletes log on every restart
mryel00
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The example crowsnet.conf does not specify what use_proxy is for and it is not immediately obvious.
The issue is discussed in #34