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

Changed the description of the h() function for the layout in the README #198

Merged
merged 3 commits into from
Mar 11, 2025

Conversation

Ptitet
Copy link
Contributor

@Ptitet Ptitet commented Mar 3, 2025

Updated the description of the layout parameter of the [ui] section for the config. The argument of the h function were left and right instead of up and down, which is confusing.

Updated the description of the `layout` parameter of the `[ui]` section for the config.
The argument of the `h` function were left and right instead of up and down, which is confusing.
@nakst
Copy link
Owner

nakst commented Mar 4, 2025

I think it could be made even more descriptive, e.g.

h(position,leftSide,rightSide)`

and

v(position,topSide,bottomSide)

Suffixed parameters of functions v() and h() with `Side` in the description of the ui layout
@Ptitet
Copy link
Contributor Author

Ptitet commented Mar 4, 2025

@nakst good idea, i've added side to each parameter name in the readme

@nakst
Copy link
Owner

nakst commented Mar 9, 2025

I think you have v() and h() the wrong way around?

@Ptitet
Copy link
Contributor Author

Ptitet commented Mar 9, 2025

For me, a vertical split splits the available space in half with a vertical line and creates two panes, one on the right side and one on the left side of the vertical line.
In the same manner, a horizontal split splits the available space in half with a horizontal line and creates two panes, one above and one below the horizontal line.
I haven't check the implementation of h() and v(), but I guess you've done the opposite from what I've described here ? If so, I'll update the README accordingly.
Thanks !

@nakst
Copy link
Owner

nakst commented Mar 11, 2025

Yes, h() divides the screen into the left and right sides, while v() divides the screen into the top and bottom sides.

Switched parameters name for functions h() and v() in the ui layout documentation to match the implementation
@nakst
Copy link
Owner

nakst commented Mar 11, 2025

Thanks for the changes!

@nakst nakst merged commit 338b690 into nakst:master Mar 11, 2025
@Ptitet Ptitet deleted the patch-1 branch March 11, 2025 12:06
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

Successfully merging this pull request may close these issues.

2 participants