bikeshedding terminology #515
nothingmuch
started this conversation in
Ideas
Replies: 1 comment
-
We've got an opportunity to make deliberate choices wrt api names before 1.0. Not so keen on running through the list right now since we've got prerequisite tasks on our plate, other than changing |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
After several months of familiarizing myself with the codebase, I'm still having trouble remembering some of the names for various methods and what they refer to.
For example, in
Receiver
, I still don't know whyextract_req
usesextract
as its verb, I forget which request that method pertains to (it's the HTTP GET request for polling the subdirectory), it uses the (non pub) methodfallback_req_body
which also isn't sticking for me.Some method names are kind of obvious when familiar with the spec, e.g.
process_res
forReceiver
could only mean one thing, the sender's proposal, but calling itres
is also a bit confusing to me. Another example that comes to mind is{en,de}crypt_message_{a,b}
. My immediate thought is that these would be a bit clearer as{en,de}crypt_{proposal,response}_payload
, but note howresponse
is already overloaded to refer to the sender's proposal inprocess res
!There are also terms in the BIP 77 spec that I believe are a bit unintuitive, e.g.
subdirectory
instead ofmailbox
. I've spoken to @DanGould about some of these things in the past, but haven't yet systematically written down my points of confusion or things I find hard to remember. Anyway I'm starting this thread to do that and hoping others would chime in, if it's just me being an airhead that's probably insufficient motivation to bikeshed terminology, especially in the spec, but if I'm not alone then maybe it's worth revisiting some of this.Beta Was this translation helpful? Give feedback.
All reactions