stride3d / stride3d/stride-docs
StartupScript type does not have comments explaining what it is
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 39
- Forks
- 74
- Avg merge
- 3h 36m
- Merged PRs (30d)
- 2
Description
Pointed out in Discord by OmniOwl
It says "update loop". But the SyncScript type is derived from StartupScript and is where the Update function is introduced. So the StartupScript talking about update loops outside of the SyncScript that derives from it and introduces the Update method is a bit confusing I must say.
Because it implies that the StartupScript has an Update method I can't see or a loop that is part of its life-cycle by default that I cannot access or see.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start from the documentation page that describes the StartupScript type and review its reference to the update loop alongside the SyncScript relationship described in the issue. Update the explanation so it does not imply that StartupScript itself exposes an Update method or lifecycle loop; done means the distinction is clear to readers.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100