Skip to content

Fix grammar and typos in syscall documentation#714

Merged
jserv merged 2 commits intosysprog21:masterfrom
minhsun-c:fix-typo
Feb 8, 2026
Merged

Fix grammar and typos in syscall documentation#714
jserv merged 2 commits intosysprog21:masterfrom
minhsun-c:fix-typo

Conversation

@minhsun-c
Copy link
Contributor

@minhsun-c minhsun-c commented Feb 8, 2026

Refine the system call documentation to improve readability and correct grammatical errors.

Changes include:

  • Fix subject-verb agreement and pluralization in audio and input sections.
  • Correct sentence fragments and punctuation in control_audio.
  • Standardize terminology for "set up" (verb) vs "setup" (noun).
  • Update technical phrasing for clearer assembly interactions.

Summary by cubic

Polished syscall documentation to fix grammar and typos and make instructions clearer. Improves readability and reduces confusion around assembly calls, input queues, and audio control.

  • Bug Fixes
    • Standardized terms: “assembly” (not “assembler”), “cannot”, “set up” (verb) vs “setup” (noun), and “SFX”.
    • Fixed grammar, punctuation, and subject–verb agreement in input and audio sections; corrected typos (e.g., enabled).
    • Clarified privilege modes and return instructions; corrected bit numbering (31st).
    • Tightened wording for parameter mapping and syscall number references.
    • Corrected SHUTDOWN_AUDIO to reference INIT_AUDIO, matching the enum definition.

Written for commit f4f11c6. Summary will update on new commits.

Copy link

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

No issues found across 1 file

Refine the system call documentation to improve readability and correct
grammatical errors.

Changes include:
- Fix subject-verb agreement and pluralization in audio and input
  sections.
- Correct sentence fragments and punctuation in `control_audio`.
- Standardize terminology for "set up" (verb) vs "setup" (noun).
- Update technical phrasing for clearer assembly interactions.
Replace the incorrect reference "INIT_SOUND" with "INIT_AUDIO" in the
SHUTDOWN_AUDIO description. This aligns the documentation with the
actual enum definition found in src/syscall_sdl.c.
@jserv jserv merged commit e10f4ba into sysprog21:master Feb 8, 2026
11 checks passed
@jserv
Copy link
Contributor

jserv commented Feb 8, 2026

Thank @minhsun-c for contributing!

@minhsun-c minhsun-c deleted the fix-typo branch February 9, 2026 02:31
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