JuliaDiff / JuliaDiff/BlueStyle

A word about short-circuit evaluation

Open
#56 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
519
Forks
34
PR merge metrics
No merged PRs in 30d

Description

A little about the stylistic usage of this functionality is mentioned in the official documentation, but I would like to see this guide's position on what and when is preferable:

if ! <cond> <statement> end

or

<cond> || <statement>

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the issue's linked Julia short-circuit evaluation documentation and inspect the existing BlueStyle guidance for related control-flow conventions. Document the guide's position on when to prefer the two shown forms, with examples that match the project's style; done means the guidance clearly addresses both alternatives.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.