Update Dictionary.get regarding the default argument & it's side effects

[AR-DEV-1]

TL;DR

• Godot counterpart: Update the Dictionary.get documentation regarding the default argument & its side effects godotengine/godot#116129
• Updates the Dictionary.get documentation with a note regarding the default argument, the fact that it's computationally expensive & it's unwanted side effects
• Also suggest the user to use the has() method instead

Note

Contributed by 2LazyDevs.

Summary by CodeRabbit

• Documentation
  • Enhanced Dictionary class documentation with comprehensive guidance on efficiently handling default values and avoiding unnecessary computation. Includes new practical examples demonstrating eager versus lazy evaluation patterns. Recommends verifying key existence before retrieval when default values are expensive to evaluate or have potential side effects.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: addc0c31-ddbd-4ef0-a1aa-3179c6bddeb9

📥 Commits

Reviewing files that changed from the base of the PR and between 3ef8058 and 9324a7e.

📒 Files selected for processing (1)

• doc/classes/Dictionary.xml

---

Walkthrough

The pull request updates the documentation for the get method in the Dictionary class. A new note was added explaining the implications of expensive or side-effectful default values, along with code examples demonstrating eager and lazy evaluation patterns.

Changes

Cohort / File(s)	Summary
Dictionary Documentation doc/classes/Dictionary.xml	Extended the get method description with a note about expensive default value evaluation and added code examples showing lazy evaluation using has before get.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly and accurately reflects the main change: updating Dictionary.get documentation to address default argument side effects, matching the file modifications and PR objectives.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[JoltedJon]

Looks good. CI that is failed was due to failing machine.
Already merged in on Godot side