JuliaDiff / JuliaDiff/BlueStyle
More guidelines on method names
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 519
- Forks
- 34
- PR merge metrics
- No merged PRs in 30d
Description
Thanks for this wonderful guide! I wanted to ask if there could be slightly more clarification/modification concerning method names. Sep
It would be nice to have consistency with base when defining methods like isimmutable where readability isn't as much of an issue. This would be especially nice for cases where a package may have code that eventually moves to base or the standard library (however rare that may be).
Potential solutions:
- Identify specific patterns that violate the underscore rule but are acceptable.
- Some sort of word combination limit (like 2 letter words don't need to be followed with an underscore)
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 guide's method-naming guidance and compare it with conventions used in Julia Base and the standard library. Decide which exceptions or word-length rules should be documented, then update the relevant guidance once the intended convention is agreed.
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