docs: clarify default parameter behavior in section Quickening it Up and fix Portuguese translation typo

Open
#264 0 comments 0 reactions 0 assignees View on GitHub

@MatheoPaiva is already working on this.

Since Nov 15, 2026.

  • #266 by @MatheoPaiva — open

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.

image

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.

image
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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ruby/TryRuby

All issues in ruby/TryRuby

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.