fix: Documentation of Transform
#1850
Open
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
The current documentation for `Flipped` states that the "Plane is flipped vertically", but the [wl_output::transform] specification describes it as a "180 degree flip around a vertical axis". The implementation follows the latter. Therefore, the documentation for `Transform::Flipped` is incorrect and needs to be updated. This patch corrects the documentation for `Transform` to remove ambiguity and align with the implementation and the Wayland specification. For more details, see https://github.com/kenoss/sabiniwm/blob/a4364ca211f97b672f92fb4de78f570f74404b90/note/issue-transform.md and #Transform-Flipped-doc-wrong. [wl_output::transform] https://wayland.freedesktop.org/docs/html/apa.html#protocol-spec-wl_output-enum-transform
5 tasks
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.
The current documentation for
Flippedstates that the "Plane is flipped vertically", but the [wl_output::transform] specification describes it as a "180 degree flip around a vertical axis". The implementation follows the latter. Therefore, the documentation forTransform::Flippedis incorrect and needs to be updated.This patch corrects the documentation for
Transformto remove ambiguity and align with the implementation and the Wayland specification.For more details, see
https://github.com/kenoss/sabiniwm/blob/a4364ca211f97b672f92fb4de78f570f74404b90/note/issue-transform.md and #Transform-Flipped-doc-wrong.
[wl_output::transform] https://wayland.freedesktop.org/docs/html/apa.html#protocol-spec-wl_output-enum-transform