JuliaDiff / JuliaDiff/BlueStyle
Guidelines for macros
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 519
- Forks
- 34
- PR merge metrics
- No merged PRs in 30d
Description
I'm currently working with AWSCore.jl and came across macro usage being over the line limit. I wasn't able to find a guideline for it here, so I figured I'd open it up to discussion.
Examples:
@delay_retry if e isa AWSException &&
(http_status(e.cause) == TOO_MANY_REQUESTS || ecode(e) in throttling_error_codes)
end
@retry if e isa AWSException && (
header(e.cause, "crc32body") == "x-amz-crc32" ||
ecode(e) in ("BadDigest", "RequestTimeout", "RequestTimeoutException")
)
end
@retry if :message in fieldnames(typeof(e)) && occursin("Signature expired", e.message) 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
Start by comparing the three macro examples in this issue with the repository’s existing style guidance. Done means the project reaches and documents an agreed rule for macros that exceed the line limit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100