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.

Sign up for GitHub

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

Jump to bottom

Unclear rotation names #76

Closed
SpecificProtagonist opened this issue May 1, 2023 · 8 comments · Fixed by #78
Closed

Unclear rotation names #76

SpecificProtagonist opened this issue May 1, 2023 · 8 comments · Fixed by #78
Assignees
@SpecificProtagonist
Labels
good first issue Good for newcomers usability Make the APIs easier to use
Milestone
0.6.0

Comments

@SpecificProtagonist
Copy link
Contributor

SpecificProtagonist commented May 1, 2023 •
edited
Loading

Is your feature request related to a problem? Please describe.
Rotation functions are named left/right and similar. This is confusing – what do left/right have to do with rotations, which direction is which? In fact, the documentation for these functions does not use these terms, it instead uses clockwise/counterclockwise, which are clear.

Describe the solution you'd like
Deprecate these functions and replace them with clockwise/counterclockwise and similar.
Alternatively this could be abbreviated as cw and ccw (as e.g. rotate_counter_clockwise is rather long).

Additional context
example of confusion
@alice-i-cecile alice-i-cecile added good first issue Good for newcomers usability Make the APIs easier to use labels May 1, 2023
@alice-i-cecile
Copy link
Collaborator

I agree: I think this would be clearer.

@GuimilXD
Copy link
Contributor

GuimilXD commented May 1, 2023

I have some free time and I think I can do this.

@ManevilleF
Copy link
Owner

That would be a solid clarity improvement

@ManevilleF ManevilleF added this to the 0.6.0 milestone May 1, 2023
@SpecificProtagonist
Copy link
Contributor Author

@GuimilXD Just saw your message; if you haven't done it yet I've already started/am mostly done.

@SpecificProtagonist SpecificProtagonist mentioned this issue May 1, 2023
Merged
@GuimilXD
Copy link
Contributor

GuimilXD commented May 1, 2023

@GuimilXD Just saw your message; if you haven't done it yet I've already started/am mostly done.

Oh no! I'm also mostly done. For consistency's sake, I thought of changing DiagonalDirection and Direction rotation functions. What do you think of that?

@SpecificProtagonist
Copy link
Contributor Author

I've adjusted them likewise (see #78). I'm not sure whether/when to use abbreviations though.

@GuimilXD
Copy link
Contributor

GuimilXD commented May 1, 2023

I was also unsure when to use abbreviations.
I think yours should be merged though.

@ManevilleF
Copy link
Owner

I just noticed your additional context, I hoped no one noticed my confusion on my own code :P

@GuimilXD GuimilXD removed their assignment May 1, 2023
alice-i-cecile pushed a commit that referenced this issue May 2, 2023
@SpecificProtagonist @ManevilleF
Rename rotation functions (#78)
48331cd 
Fixes #76 

Open question: Should the functions be
- spelled out: `clockwise`/`counter_clockwise`
- abbreviated: `cw`/`ccw`
- abbreviated only in compounds: e.g. `clockwise()` and
`rotate_ccw_around()`

---------

Co-authored-by: Félix Lescaudey de Maneville <felix.maneville@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@SpecificProtagonist SpecificProtagonist

Labels
good first issue Good for newcomers usability Make the APIs easier to use
Projects
None yet
Milestone
0.6.0
Development

Successfully merging a pull request may close this issue.

Rename rotation functions SpecificProtagonist/hexx
4 participants
@alice-i-cecile @ManevilleF @SpecificProtagonist @GuimilXD