Skip to content

docs: fix C# keyword collision in README Quick Start#29

Merged
rubenhensen merged 1 commit into
mainfrom
fix/readme-sealed-keyword
May 28, 2026
Merged

docs: fix C# keyword collision in README Quick Start#29
rubenhensen merged 1 commit into
mainfrom
fix/readme-sealed-keyword

Conversation

@dobby-coder

@dobby-coder dobby-coder Bot commented May 27, 2026

Copy link
Copy Markdown
Contributor

The Quick Start snippet uses sealed as a local variable name, which is a C# reserved keyword and fails to compile when pasted into a project. Renames the variable to encrypted in both the assignment and .UploadAsync() call site.

Closes #25

'sealed' is a reserved C# keyword, so the README snippet fails to
compile when pasted into a project.

Closes #25
@dobby-coder dobby-coder Bot requested a review from rubenhensen May 27, 2026 23:35

@dobby-coder dobby-coder Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Verdict: LGTM — would approve if GitHub allowed self-approval.

Verified the fix:

  • sealed is indeed a C# reserved keyword — var sealed = ... would fail compilation with CS1041.
  • Both call sites (line 19 assignment and line 26 .UploadAsync() call) are renamed consistently to encrypted.
  • Grepped the rest of the repo for \bsealed\b — remaining matches are doc-comments inside Sealed.cs / SealPipeline.cs referring to "sealed bytes", not variable names. Nothing else to change.
  • PR title follows conventional-commit format.

Closes #25 cleanly. Safe to merge.

@rubenhensen rubenhensen merged commit 1480dce into main May 28, 2026
2 checks passed
@rubenhensen rubenhensen deleted the fix/readme-sealed-keyword branch May 28, 2026 07:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README Quick Start uses C# reserved keyword sealed as variable name

1 participant