Skip to content

Fix language mistakes in the documentation - #895

Merged
holgpar merged 2 commits into
mainfrom
holger/improveDocs
Oct 12, 2026
Merged

holgpar merged 2 commits into
mainfrom
holger/improveDocs

Conversation

@holgpar

@holgpar holgpar commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

Fix some typos

@holgpar
holgpar requested a review from a team as a code owner October 5, 2026 13:54
@holgpar
holgpar requested a review from tomk8r October 5, 2026 13:54
@hyperspace-pr-bot

Copy link
Copy Markdown
Contributor

Summary

The following content is AI-generated and provides a summary of the pull request:


Improve Design Documentation Wording and Grammar

Documentation

📝 Cleaned up doc/Design.md by fixing typos, grammar, punctuation, and wording throughout the attachment feature design documentation. These updates improve readability without changing any documented behavior or implementation details.

Changes

  • doc/Design.md: Refined wording across sections covering CDS model annotations, handlers, draft activation, delete behavior, draft keys, readonly fields, optimistic concurrency control, attachment service behavior, malware scanning, and tests.
  • doc/Design.md: Fixed terminology consistency such as “delete event”, “create event”, “content ID”, “event context”, and “top-level entity”.
  • doc/Design.md: Corrected typos and grammar issues in descriptions of AttachmentService, DefaultAttachmentService, DefaultAttachmentsReader, malware scan handling, and draft-related processing.

  • 🔄 Regenerate and Update Summary
  • ✏️ Insert as PR Description (deletes this comment)
  • 🗑️ Delete comment
PR Bot Information

Version: 1.31.69

  • LLM: gpt-5.5
  • Event Trigger: pull_request.opened
  • Correlation ID: 46d6eed0-c0c4-11f1-97c9-3475d91d62c7
  • File Content Strategy: Full file content
  • Summary Prompt: Default Prompt
  • Output Template: Default Template

@hyperspace-pr-bot hyperspace-pr-bot Bot 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.

The typo cleanup is generally readable, but several class references remain stale and do not match the current implementation. I posted inline suggestions to align the design document with the repository’s actual class names.

PR Bot Information

Version: 1.31.69

  • LLM: gpt-5.6-sol
  • Event Trigger: pull_request.opened
  • Correlation ID: 46d6eed0-c0c4-11f1-97c9-3475d91d62c7
  • Experiment Variant: treatment
  • Agent Instructions:
  • File Content Strategy: Full file content

Comment thread doc/Design.md
Comment thread doc/Design.md
Comment thread doc/Design.md
Comment thread doc/Design.md
Comment thread doc/Design.md
tomk8r
tomk8r previously approved these changes Oct 5, 2026

@tomk8r tomk8r left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

thanks - just one minor suggestion below.
Remaining minor nit: There is still a mix of hyphenated and non-hyphenated forms, e.g. delete-event vs. delete event. We can fix later.

Comment thread doc/Design.md Outdated
@holgpar

holgpar commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor Author

thanks - just one minor suggestion below. Remaining minor nit: There is still a mix of hyphenated and non-hyphenated forms, e.g. delete-event vs. delete event. We can fix later.

I switched to the un-hyphenated forms.

@holgpar
holgpar force-pushed the holger/improveDocs branch 3 times, most recently from f9f0233 to 521e9d4 Compare October 9, 2026 13:41
@holgpar
holgpar force-pushed the holger/improveDocs branch from 521e9d4 to 3694d50 Compare October 9, 2026 13:50
@holgpar holgpar changed the title holger/improveDocs Fix language mistakes in the documentation Oct 9, 2026
@holgpar
holgpar requested a review from tomk8r October 12, 2026 13:53
@holgpar
holgpar enabled auto-merge (squash) October 12, 2026 14:01
@holgpar
holgpar merged commit 0f6318a into main Oct 12, 2026
20 checks passed
@holgpar
holgpar deleted the holger/improveDocs branch October 12, 2026 14:09
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