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

Cardinal focus: wrong documentation and possible room for improvement #187

Open
xalexalex opened this issue Jun 25, 2022 · 1 comment
Open

Comments

@xalexalex
Copy link

xalexalex commented Jun 25, 2022

Hey,

berry/berryc.1

Line 74 in b563041

\fBcardinal_focus\fR \fB1, 2, 3, 4\fR
says that the arguments to cardinal focus are "1,2,3,4", but

berry/types.h

Lines 77 to 82 in b563041

enum direction {
EAST,
NORTH,
WEST,
SOUTH
};
implies that the arguments should be "0,1,2,3" for "E,N,W,S" respectively.

I could have filed a PR to simply change 1,2,3,4 to 0,1,2,3 in berryc.1. However, I feel the documentation as it stands is not clear: how am I supposed to map 1,2,3,4 to E,N,W,S?

Thus I'd like to discuss. At least I think we should mirror hjkl and thus make the enum E,S,N,W, but ideally the user should not deal with the numbers at all and he could use instead berryc cardinal_focus north or N or up or something more meaningful.

What do you think?

@Echinoidea
Copy link

Bump. I just encountered this issue. The website says simple 1/2/3/4 without elaboration. 0 for east, 1 for north, 2 for west, and 3 for south.

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

No branches or pull requests

2 participants