Skip to content
This repository was archived by the owner on Mar 28, 2023. It is now read-only.

What is the commenting style? #122

Closed
JustinDrake opened this issue Sep 8, 2016 · 6 comments
Closed

What is the commenting style? #122

JustinDrake opened this issue Sep 8, 2016 · 6 comments
Labels

Comments

@JustinDrake
Copy link
Contributor

JustinDrake commented Sep 8, 2016

Comments are a bit messy. Sometimes they start with a capital, sometimes not. Sometimes they end with a dot, sometimes not. What is the commenting style to be followed in openbazaar-go?

@cpacia
Copy link
Member

cpacia commented Sep 8, 2016

What do you want it to be?

@JustinDrake
Copy link
Contributor Author

My personal preference is for comment fragments to start with a capital and end with no dot. If the comment is one or more full sentences (a sentence has at least a subject and a verb) then the sentences should end with a dot. Sounds good?

@cpacia
Copy link
Member

cpacia commented Sep 8, 2016

That works

@morebrownies
Copy link
Collaborator

Keep in mind we have many languages to consider

@JustinDrake
Copy link
Contributor Author

@morebrownies What do you mean? Are you referring to some error messages that may need translating, or inline code comments?

@morebrownies
Copy link
Collaborator

Nevermind, I thought you were referring to user reviews. I misread.

On Sep 8, 2016 3:51 PM, "Justin" [email protected] wrote:

@morebrownies https://github.com/morebrownies What do you mean? Are you
referring to some error messages that may need translating, or inline code
comments?


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#122 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AMdihlG8qCTdOpwaoi62uUBB7YzeG48lks5qoJF2gaJpZM4J4fsr
.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

3 participants