JuliaDiff / JuliaDiff/BlueStyle
Exempting literal strings from line limits?
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 519
- Forks
- 34
- PR merge metrics
- No merged PRs in 30d
Description
It is not uncommon to want verbose logging messages (in the internal Invenia codebase, and Production systems more generally).
If there are multiple log statements, it is easy to end up with 5-10 lines dedicated some form of logging messages. But once a function is over ~30 lines it becomes hard to read, just because of the amount of vertical space used. So for log messages, the horizontal space limit puts notable pressure on the vertical space.
One option to address this would be to exempt literal strings from line limits, then codebases can choose to allow log messages that are greater than 92 chars, without incurring lots of vertical space.
e.g.
to allow
function do_thing(status)
is_good(status) || warn(LOGGER, "Whoa there. Things aren't all good. Doing the thing may lead to some seriously weird stuff happening.")
return the_thing()
end
rather than things like this:
function do_thing(status)
is_good(status) || warn(
LOGGER,
"Whoa there. Things aren't all good. " *
"Doing the thing may lead to some seriously weird stuff happening."
)
return the_thing()
end
function do_thing(status)
if !is_good(status)
warn(
LOGGER,
string(
"Whoa there. Things aren't all good. ",
"Doing the thing may lead to some seriously weird stuff happening."
)
)
end
return the_thing()
end
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are named. Start by reviewing the existing line-limit rules and the 13-comment discussion, then establish whether literal strings should be exempt and how that exception is defined. Done should include a documented, agreed rule for the logging examples and any required implementation or test locations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100