JuliaDiff / JuliaDiff/BlueStyle

No line breaks after `=`

Open
#39 2 comments 3 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

Discussed w/ @nickrobinson251 offline, we should add rule that states to never line break after an = operation.

Example:

# Yes
function_result = some_long_function_that_goes_over_the_92_char_line_limit(
    some_param, 
    another_param
)

# No
function_result = 
    some_long_function_that_goes_over_the_92_char_line_limit(some_param, another_param)

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

Locate the BlueStyle style-guide section covering line breaks and assignment expressions, then read the surrounding rules and examples. Add the requested guidance and contrasting examples so the rule clearly prohibits breaking immediately after =; done when the style guide states this consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.