Skip to content
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

Add 'when not to use curly braces' entry to style README #13

Closed
wants to merge 1 commit into from
Closed

Add 'when not to use curly braces' entry to style README #13

wants to merge 1 commit into from

Conversation

ghubstan
Copy link
Member

Added first entry to the style guide, explaining that devs
should not surround one line code blocks under if / else / while
statements with {curly braces}.

This patch was created in response to a comment in PR #3134
bisq-network/bisq#3134 (comment)

Since this is the first entry, and no protocol for asciidoc usage
has been defined, there will eventually need to be some discussion
about breaking up the readme into a table of contents linking to
sub-docs, and consistent usage of the asciidoc syntax.

Added first entry to the style guide, explaining that devs
should not surround one line code blocks under if / else / while
statements with {curly braces}.

This patch was created in response to a comment in PR #3134
bisq-network/bisq#3134 (comment)

Since this is the first entry, and no protocol for asciidoc usage
has been defined, there will eventually need to be some discussion
about breaking up the readme into a table of contents linking to
sub-docs, and consistent usage of the asciidoc syntax.
@ManfredKarrer
Copy link
Member

Actually we tended to use always brackets as it has caused already a few timed bugs in the past, specially if code got added later.

@ghubstan
Copy link
Member Author

If it were up to me (only), I would also use brackets for the reasons stated above. I'm closing this PR and reverting the related commit back to using brackets around the one line block.

@ghubstan ghubstan closed this Aug 26, 2019
@ghubstan ghubstan deleted the omit-unnecessary-curly-braces branch August 26, 2019 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants