-
Notifications
You must be signed in to change notification settings - Fork 14
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.
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
Update guideline for comments for interface implementation. #15
Conversation
For the record, we went through many possibilities: // Stream belongs to the mino.RPC implementation
// Stream implements mino.RPC.Stream
// Stream implements mino.RPC.Stream()
// Stream implements mino.RPC
// Stream contributes to mino.RPC
// Stream contributes to implementing mino.RPC
// Stream belongs to the mino.RPC interface
// Stream is an element of the mino.RPC interface
// Stream is a member of mino.RPC
// Stream belongs to mino.RPC
// Stream belongs to interface mino.RPC
// Stream belongs to mino.RPC interface And we choose to favour a concise and easy to remember phrasing with |
Co-Authored-By: Noémien Kocher <nkcr.je@gmail.com>
|
||
func TestDummy_String(t *testing.T) {} | ||
``` | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add something to handle more complex situation, like:
For some situation, it is necessary to add detailed information about a test case. This can be done between the SCOPE and the FUNCTION:
func Test_RPC_MultipleSimple_Stream(t *testing.T) {
...
}
As an invariant, the SCOPE and FUNCTION should always be the first, respectively the last, element.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
Update guideline for comments for interface implementation.
No description provided.