chickensoft-games / chickensoft-games/AutoInject

docs: possible error in example code

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

Nobody has claimed this yet.

documentation
Dominant language
C#
Stars
237
Forks
14
Avg merge
6h 40m
Merged PRs (30d)
6

Description

While working on a PR for GodotNodeInterfaces, a contributor was unable to connect AutoConnect nodes using the example code given in the README ( _scene._Notification((int)Node.NotificationSceneInstantiated)) and instead was able to connect them using a different notification (_scene._Notification((int)Node.NotificationEnterTree)). The README may need to be revised.

Contributor guide

Open the 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.

Research direction

Start with the AutoConnect example in the README and read the linked GodotNodeInterfaces PR discussion for the reported connection failure. Verify the notification behavior in the example context, then revise the README example if needed so it reflects a working notification and clearly documents the expected result.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, godot
Domain
documentation, game-dev
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.