docs: clarify default parameter behavior in section Quickening it Up and fix Portuguese translation typo
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 40/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- ruby
- Domain
- documentation
Research direction
Open the "Quickening it Up" section of the tutorial and its Portuguese counterpart, and locate the paragraph describing the initialize default argument (content="" / conteudo=""). Compare the two texts: the English one needs the wording softened to say the default only applies when the argument is omitted, and the Portuguese one additionally carries a stray __. Make the prose match across translations with consistent inline code around parameter names, then view the rendered pages to confirm. Note an open pull request (#266) already targets this, so check it before starting to avoid duplicate work.
Written by the indexing model from the issue text.
Description
Section: Quickening it Up
Description
The Ruby tutorial's explanation of the initialize method contains two issues:
1. Misleading explanation (identified in both English and Portuguese)
Both versions suggest that the default argument (content="" / conteudo="") guarantees the parameter is a string.
However, the default value only applies when the argument is omitted. Passing nil or another incompatible value explicitly can still cause an error.
Suggested wording (English):
"The default value content="" ensures that content is an empty string when no argument is provided."
Suggested wording (Portuguese):
"O valor padrão conteudo="" garante que conteudo seja uma string vazia quando nenhum argumento for informado."
2. Formatting typo (Portuguese only)
The Portuguese translation contains an unexpected __ in the paragraph explaining the default parameter. This does not appear in others version.
Expected behavior
- Both translations accurately describe Ruby's default argument behavior.
- The Portuguese version no longer contains the unintended
__. - Parameter names and values use consistent inline code formatting.
- Dominant language
- Ruby
- Stars
- 258
- Forks
- 113
- PR merge metrics
- No merged PRs in 30d
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- No contributing 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.
More from ruby/TryRuby
-
Difficulty 3/5 1-2 days Newbie friendliness 64/100
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
Similar issues
-
🐛 bug 👩💻 équipe CE 🧑🏭 entreprises
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
betagouv/conseillers-entreprises#4808 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
yosiat/panko_serializer#250 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
cline/mcp-marketplace#3886 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100