Skip to content

docs(http-client-csharp): document client method parameter reordering - #12044

Merged
JoshLove-msft merged 2 commits into
microsoft:mainfrom
JoshLove-msft:joshlove-msft-csharp-parameter-ordering
Sep 24, 2026
Merged

JoshLove-msft merged 2 commits into
microsoft:mainfrom
JoshLove-msft:joshlove-msft-csharp-parameter-ordering

Conversation

@JoshLove-msft

@JoshLove-msft JoshLove-msft commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Add the missing client-method parameter-ordering scenario to the C# backward-compatibility documentation and table of contents.
  • Show how protocol and convenience methods retain their previously published parameter order, including async variants.
  • Explain the last-contract requirement, matching constraints, and updates to forwarded arguments and parameter XML documentation.

Documentation only; no generator behavior changes or changelog entry.

Validation

  • GitHub Consistency run 36047076718 passed on commit 731fd39cf: Format, Lint, Spell check, Check Changes, and Versions consistency.
  • Built the repository's TypeSpec Prettier plugin with Node 24 and pinned pnpm 11.10.0, reproduced the original formatting failure, and ran full pnpm format. The only correction was collapsing the new embedded TypeSpec operation onto one line.
  • The changed document passes the configured Prettier check, including the TypeSpec plugin; git diff --check also passed.
  • The earlier local restore failure was caused by the older installed pnpm version, not a lockfile defect. No dependency or lockfile changes were needed.
  • Local full lint was blocked by incomplete workspace dependencies and a compiler tsconfig error; the GitHub Lint check passed.
  • Generator build and unit tests were not run locally because this is a documentation-only change.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@pkg-pr-new

pkg-pr-new Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@typespec/http-client-csharp@12044

commit: 731fd39

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approval recommended

Documentation changes were reviewed with no unresolved issues.

Review effort: Lite
Findings: None

What changed in this PR

Documents C# client method parameter reordering for backward compatibility.

Changes:

  • Adds the scenario to the table of contents.
  • Documents protocol, convenience, and async method ordering.
  • Explains matching constraints, argument forwarding, and XML documentation.
File Description
packages/​http-client-csharp/​generator/​docs/​backward-compatibility.md Adds parameter-ordering compatibility guidance and examples.

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@github-actions

Copy link
Copy Markdown
Contributor

No changes needing a change description found.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings September 24, 2026 19:16

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🔵 Needs a closer look

Address the two requested documentation clarifications before approval.

Review effort: Lite
Findings: None

@JoshLove-msft
JoshLove-msft added this pull request to the merge queue Sep 24, 2026
Merged via the queue into microsoft:main with commit 9ab53f7 Sep 24, 2026
30 checks passed
@JoshLove-msft
JoshLove-msft deleted the joshlove-msft-csharp-parameter-ordering branch September 24, 2026 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

emitter:client:csharp Issue for the C# client emitter: @typespec/http-client-csharp

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants