Clarifications and terms concistency
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- Half a day
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start with the linked page, getting_started/step_by_step/scripting_first_script, and find where _process(), _input() and _unhandled_input() are called 'virtual functions' and where they are called 'callbacks'. The issue does not say which term to keep, so agree on one with a maintainer first. Done means the tutorial pages use that single term consistently, or clarify it once where the two terms first meet.
Written by the indexing model from the issue text.
Description
Redot: 26.1
The documentation uses several different terms to describe the same concepts, which makes it confusing for beginners.
For example, the tutorial refers to _process(), _input(), _unhandled_input(), etc. as “virtual functions” in one section, and later calls them “callbacks” without explaining that these two terms refer to the same concept.
Using multiple names for the same mechanism without clarification creates unnecessary confusion. It would help if the documentation consistently used a single term.
https://docs.redotengine.org/getting_started/step_by_step/scripting_first_script#complete-script
- Dominant language
- C#
- Stars
- 4
- Forks
- 7
- Avg merge
- 6h 10m
- Merged PRs (30d)
- 4
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 Redot-Engine/Redot-Documentation
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
-
Asset library section incorrectly refers to Redot instead of GodotMay be free again A pull request for this issue was closed without being merged. Openclarification good first issue help wanted rebranding issue
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Redot-Engine/Redot-Documentation#50 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
-
Dokploy fails to build previews for PRsPossibly taken @decryptedchaos claimed this 27 days ago. Openbug
Redot-Engine/Redot-Documentation#54 · 1 comment · 1 assignee ·
-
Chore: Broken link checkMay be free again A pull request for this issue was closed without being merged. Opengood first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
Redot-Engine/Redot-Documentation#51 · 2 comments ·
All issues in Redot-Engine/Redot-Documentation
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
mode_has_nan gives MSVC warning C4702 (unreachable code)Possibly taken @ibmibmibm claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
georgeslegros/stream-deck-pilot#149 ·
Maintainers usually reply within 1 day
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
MustacheCase/zanadir#506 ·
Maintainers usually reply within 1 day