You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hello. First of all, thanks for the awesome work on this!
I wanted to bring up a minor issue regarding the naming convention used for the library classes. The official Kotlin coding conventions guide specifies the following:
When using an acronym as part of a declaration name, capitalize it if it consists of two letters (IOStream); capitalize only the first letter if it is longer (XmlFormatter, HttpInputStream).
Overall, the library is using capitalized RPC everywhere. I think for the RPC declaration it's ok, but RPCClient, RPCServer, for example, should actually be RpcClient and RpcServer.
Again, this is minor, but it would be nice to follow the official conventions. I can open a PR with this change if you all agree.
The text was updated successfully, but these errors were encountered:
We should indeed take a better look at how we follow conventions in our namings, as we, for example, have even larger caps namings like KRPCClient. 5 caps letters in a row! Scary!
Anyway, thanks for bringing that up. We will conduct internal design sessions where we will revisit all public APIs for this and other matters, so no need for a PR from your side. Can not promise, how long it could take, so hope it is not critical right now
Basically keeping it all caps when referencing the concept in docs, and changing the name in code (including the RPC interface) with type aliases/inline functions for some short-term source compatibility
And here's some (or all?) of the RPC declarations here for anyone curious
Hello. First of all, thanks for the awesome work on this!
I wanted to bring up a minor issue regarding the naming convention used for the library classes. The official Kotlin coding conventions guide specifies the following:
(https://kotlinlang.org/docs/coding-conventions.html#choose-good-names)
Overall, the library is using capitalized
RPC
everywhere. I think for theRPC
declaration it's ok, butRPCClient
,RPCServer
, for example, should actually beRpcClient
andRpcServer
.Again, this is minor, but it would be nice to follow the official conventions. I can open a PR with this change if you all agree.
The text was updated successfully, but these errors were encountered: