JuliaDiff / JuliaDiff/BlueStyle
Style for (sub)modules?
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 519
- Forks
- 34
- PR merge metrics
- No merged PRs in 30d
Description
e.g. don't indent inside `module ... end"?
# Yes
module Foo
export bar
bar() = 1
end
# No
module Foo
export bar
bar() = 1
end
Perhaps other rules? e.g. Blank line after module and before end?
# Yes
module Foo
export bar
bar() = 1
end
# No
module Foo
export bar
bar() = 1
end
it'd also be kind nice to add a comment after end e.g. end # module?
Raised by @iamed2 in https://github.com/invenia/LibPQ.jl/pull/197#discussion_r494658414
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
Review the two Julia module-formatting examples and the linked LibPQ.jl discussion first. Determine which indentation, blank-line, and end-comment rules the project wants, then document the agreed conventions in the style guide; done means the rules are decided and clearly recorded.
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
- 30/100