JuliaDiff / JuliaDiff/BlueStyle
Function declaration ordering
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 519
- Forks
- 34
- PR merge metrics
- No merged PRs in 30d
Description
Does anyone else wish we had a convention on ordering of functions in a file? I typically find putting private (more specific) functions further down in a file is more readable, but I don’t think that’s consistent. I also think some folks prefer the opposite to make copy-pasting into a REPL more intuitive? I suppose you could make the claim that they should just live in a different utilities file, but if they’re only used in that one file it’s kinda nice to keep them together...
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 file or test is named. Start by reading the existing BlueStyle guidance and the issue discussion to determine whether a function-ordering convention is wanted; done means reaching agreement on the convention and documenting it in the style guide.
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
- 25/100