📝 Docs: Incomplete sentence in README configuration section - #350
Open
chinhkrb113 wants to merge 1 commit into
Open
📝 Docs: Incomplete sentence in README configuration section#350chinhkrb113 wants to merge 1 commit into
chinhkrb113 wants to merge 1 commit into
Conversation
The description for the `COTURN_ENABLED` environment variable is cut off mid-sentence ("connecting peers behi"). This leaves users without complete information on what the variable does or why they might need it.
Affected files: README.md
Signed-off-by: ChinhLee <76194645+chinhkrb113@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
The description for the
COTURN_ENABLEDenvironment variable is cut off mid-sentence ("connecting peers behi"). This leaves users without complete information on what the variable does or why they might need it.Severity:
mediumFile:
READMESolution
Complete the sentence in the README:
- COTURN_ENABLED – When set to true, enables TURN support for connecting peers behind restrictive NATs.Changes
README.md(modified)Testing