Consider whether to remove empty parens in Ruby snippets
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
Currently we use empty parens in Ruby snippets in the docs, a'la:
r.table('foo').max()
It seems to be common style in Ruby to elide empty parens like:
r.table('foo').max
ping @mlucy @mglukhovsky @gchpaco. If eliding the empty parens is pretty universal in Ruby code, I think we should do it. But if it's a "some people do, some people don't" then it's not worth bothering since most Ruby devs will be used to seeing empty parens regularly and it won't look off to them.
Note I'm just talking about eliding empty parens, not all parens in Ruby snippets.
Contributor guide
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
Search the documentation for Ruby snippets that use empty parentheses and review the issue's style question against common Ruby conventions. Done means deciding whether the style is sufficiently universal and, if so, updating the affected snippets consistently; the issue names no specific files or tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100