Rename Sel.SecretKey.Cipher.Hash to Ciphertext #182
Conversation
| @@ -255,16 +255,16 @@ nonceToHexByteString (Nonce nonceForeignPtr) = | |||
| -- | A ciphertext consisting of an encrypted message and an authentication tag. | |||
| -- | |||
| -- @since 0.0.1.0 | |||
| data Hash = Hash | |||
| data Ciphertext = Ciphertext | |||
There was a problem hiding this comment.
Do we prefer Ciphertext or CipherText?
I noticed a little bit of inconsistency:
In Sel.PublicKey.Cipher and Sel.SecretKey.Stream, we have two types named CipherText. However, in Sel.SecretKey.Stream, there are functions where this capitalization is not consistent: ciphertextFromHexByteString, ciphertextToBinary, etc.
Just let me know which way you guys prefer and I can make the changes throughout the project, if you like.
There was a problem hiding this comment.
I've personally always used "ciphertext" as a single word but, of course, I'd like to comply with the API that you prefer.
| -- | Create a 'Hash' from a binary 'StrictByteString' that you have obtained on your own, | ||
| -- usually from the network or disk. It must be a valid hash built from the concatenation | ||
| -- of the encrypted message and the authentication tag. | ||
| -- | Create a 'Ciphertext' from a hexadecimal-encoded 'StrictByteString' that | ||
| -- you have obtained on your own, usually from the network or disk. It must be | ||
| -- a valid ciphertext built from the concatenation of the encrypted message and | ||
| -- the authentication tag. |
There was a problem hiding this comment.
Any idea what line width we're generally targeting? I changed this to 80 chars when updating the docs, but I'm happy to comply with whatever you prefer.
Resolves #181