Skip to content

Comments

[Docs] [C#] Update docs with List<T> returns and IEnumerable<T> tests#4392

Open
rekhoff wants to merge 20 commits intomasterfrom
rekhoff/docs-csharp-query-build-update
Open

[Docs] [C#] Update docs with List<T> returns and IEnumerable<T> tests#4392
rekhoff wants to merge 20 commits intomasterfrom
rekhoff/docs-csharp-query-build-update

Conversation

@rekhoff
Copy link
Contributor

@rekhoff rekhoff commented Feb 22, 2026

Description of Changes

  • Updates 00500-views.md with:
    • Changes returned value to a nullable value, to match the return type defintion.
    • Wraps sample code in public partial class Module so pasting it in to IDE will not return errors.
  • Updates 00500-cheat-sheet.md with:
    • Changes reducer names to not start with On to avoid error STDB0010: Reducer method OnConnect starts with 'On', which is a reserved prefix.
    • Adds Accessor values to views.
    • Updates Filter() returned value to use .ToList() and the return type to use List<Player> rather than IEnumerable<Player> to avoid error, due to needing a return type to be Vec<T> or Option<T>.
  • Updated Coddgen.Test to include tests verifying current behavior of IEnumerable<T>, to aid in future update to allow a return type of IEnumerable<T> to be allowed and converted internally to the required type.

API and ABI breaking changes

None

Expected complexity level and risk

1 – documentation-only edits with no behavioral impact.

Testing

  • Changed code blocks tested locally to ensure formatting resolved in IDE.

@rekhoff rekhoff self-assigned this Feb 22, 2026
@rekhoff rekhoff added the documentation Improvements or additions to documentation label Feb 22, 2026
@joshua-spacetime
Copy link
Collaborator

Is this change still applicable? #4393 removes Query entirely, right?

@joshua-spacetime
Copy link
Collaborator

We should remove any references to Query in the docs and replace with IQuery. llms.md is one such place - see #4394. But I'm not sure if there are others.

@rekhoff rekhoff marked this pull request as ready for review February 23, 2026 20:10
@rekhoff rekhoff changed the title [Docs] [C#] Update docs with C# Query Builder use of Query and Build() [Docs] [C#] Update docs with List<T> returns and IEnumerable<T> tests Feb 23, 2026
Copy link
Contributor

@JasonAtClockwork JasonAtClockwork left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@rekhoff rekhoff added this pull request to the merge queue Feb 24, 2026
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Feb 24, 2026
@rekhoff rekhoff enabled auto-merge February 25, 2026 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants