Rename KeyPair to Keypair #648
Merged
Conversation
This file contains 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
We use "keypair" in identifiers (local vars and function names) but `KeyPair` - one of them is wrong. Elect to follow upstream and define keypair as a single word i.e., use `Keypair` for type name and `keypair` in identifiers. This patch can be reproduced mechanically by doing two search-and-replace operations on all files excluding the CHANGELOG - Replace "KeyPair" with "Keypair" - Replace "key_pair" with "keypair"
apoelstra
approved these changes
Aug 20, 2023
|
I think this will be quite unintuitive for most rustceans and also breaks the API IMO unnecessarily :( |
|
@Kixunil I have never seen "keypair" split into two words, and might even have trouble understanding it if I read it. I agree that in an API, somehow the two-word version feels nicer, but it doesn't match the libsecp API or any documentation. |
|
Ah, this is classic issue with people being new to this kind of cryptography - they may not realize it's usually one word. I'm not even new and I just don't remember. So I guess there's no real solution and let's just not make more work. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We use "keypair" in identifiers (local vars and function names) but
KeyPair- one of them is wrong.Elect to follow upstream and define keypair as a single word i.e., use
Keypairfor type name andkeypairin identifiers.This patch can be reproduced mechanically by doing two search-and-replace operations on all files excluding the CHANGELOG
Fix #647