man: fix incorrect smart_borders documentation #8466
Conversation
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
Currently, the documentation for smart_borders claims that when smart_borders is set to 'no_gaps', borders will only be enabled when the workspace has more than one visible child and gaps are equal to zero. However, the real behavior of 'no_gaps' is that borders are enabled when: - The workspace has more than one visible child. or, - There are non-zero gaps between any of the workspace's edges and the corresponding edge of the output. This commit adjusts the wording of the smart_borders documentation to reflect the true behavior of the option.
Member
|
Notes:
|
Contributor
Author
Yes the documentation regarding all the smart features was very confusing (and sometimes wrong) when I was first reading it. I had to resort to looking at the code to see what it did. |
Contributor
Author
|
After not looking at this for months and re-reading the changes I made to the documentation, I am not sure that my changes make the docs any less confusing. It might even make things more confusing. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Currently, the documentation for smart_borders claims that when smart_borders is set to 'no_gaps', borders will only be enabled when the workspace has more than one visible child and gaps are equal to zero. However, the real behavior of 'no_gaps' is that borders are enabled when:
or,
This commit adjusts the wording of the smart_borders documentation to reflect the true behavior of the option.