Skip to content

chore: Refactor ESDK decrypt.md#314

Open
lucasmcdonald3 wants to merge 16 commits intomasterfrom
update-decrypt
Open

chore: Refactor ESDK decrypt.md#314
lucasmcdonald3 wants to merge 16 commits intomasterfrom
update-decrypt

Conversation

@lucasmcdonald3
Copy link
Contributor

Issue #, if available:

Description of changes:

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Check any applicable:

  • Were any files moved? Moving files changes their URL, which breaks all hyperlinks to the files.

@lucasmcdonald3 lucasmcdonald3 requested a review from a team as a code owner March 6, 2026 18:38
@lucasmcdonald3 lucasmcdonald3 requested review from Copilot and removed request for a team March 6, 2026 18:38
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR refactors the ESDK decrypt.md specification document by removing version history, implementation tables, and RFC2119 conventions (moving the latter to the top-level README.md), and rewording specification language to be more explicit with RFC2119 keywords (MUST/SHOULD) and to use clearer subject references (e.g., "the Decrypt operation" instead of "this operation").

Changes:

  • Removed changelog, implementation table, and RFC2119 conventions section from decrypt.md, relocating the RFC2119 reference to README.md.
  • Rewrote input/output sections and operational steps to use more explicit RFC2119 language and consistent naming.
  • Replaced ambiguous "this operation" references with specific subjects like "the Decrypt operation" or "the streamed Decrypt operation".

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File Description
client-apis/decrypt.md Removed version/changelog/implementations sections, rewrote input/output/steps with explicit RFC2119 keywords and clearer subjects
README.md Added top-level RFC2119 conventions section

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

lucasmcdonald3 and others added 3 commits March 6, 2026 10:49
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.

2 participants