JuliaDiff / JuliaDiff/BlueStyle
Multi-line comments use `#` or `#=`?
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 519
- Forks
- 34
- PR merge metrics
- No merged PRs in 30d
Description
Looking at the guide I came across this example:
# Yes:
# Number of nodes to predict. Again, an issue with the workflow order. Should be updated
# after data is fetched.
p = 1
# No:
p = 1 # Number of nodes to predict. Again, an issue with the workflow order. Should be
# updated after data is fetched.
What are peoples thoughts on this style:
#=
Number of nodes to predict. Again, an issue with the workflow order. Should be
updated after data is fetched.
=#
p = 1
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
Read the guide section containing the shown Julia comment examples, then review the eight-comment thread for the unresolved style question. Done means reaching and recording a clear convention for multi-line comments in the 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