[Docs] Update Entity.cs XML Comments
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 7.8k
- Forks
- 1.2k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 49
Description
Describe the update or improvement you would like to see
Check correctnes of XML comments in Entity.cs, specifically correct this one, this is not correct
<returns>The component or null if does no exist</returns>
Is this related to a specific part of the documentation?
VS intellisense and Stride Docs API
Why is this update needed?
The return value comment needs to be clear and not confusing.
Additional context
n/a
Proposed changes
n/a
Contributor 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.
Research direction
Open sources/engine/Stride.Engine/Engine/Entity.cs around lines 204–213 and review the XML comments for the referenced return value. Correct the wording so the component-or-null behavior is clear, then confirm the updated comment appears correctly in Visual Studio IntelliSense and Stride Docs API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100