[Docs] Update Entity.cs XML Comments

Open Beginner friendly
#2,452 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
csharp
Domain
documentation

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.

Description

area-Doc

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>

https://github.com/stride3d/stride/blob/master/sources/engine/Stride.Engine/Engine/Entity.cs#L204-L213

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

Dominant language
C#
Stars
7.8k
Forks
1.2k
Avg merge
2d 9h
Merged PRs (30d)
55

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.

More from stride3d/stride

All issues in stride3d/stride

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.