Skip to content

docs: fix typos in doc comments (settings, API, synth) - #2964

Open
juapperez wants to merge 1 commit into
CoderLine:developfrom
juapperez:docs/typos-in-doc-comments
Open

juapperez wants to merge 1 commit into
CoderLine:developfrom
juapperez:docs/typos-in-doc-comments

Conversation

@juapperez

@juapperez juapperez commented Oct 20, 2026 •

Copy link
Copy Markdown

Note

AI-authored disclosure (alphatab-ai-authored-v1)

Portions of this content were authored by an AI agent. The agent has read
AGENTS.md and the human submitter accepts responsibility for
compliance with the rules in that document.

Issues

Not linked to an accepted issue: this is a spelling-only change to doc comments. If you would rather have an issue first, or prefer to regenerate the generated/*Json.ts files yourselves, say so and I will adjust or close.

Proposed changes

Fixes typos in doc comments that feed the generated reference pages on alphatab.net: Altenatively, initally (CoreSettings), varaint (DisplaySettings), contolled (PlayerSettings), preceeded (NotationSettings), reacing ×2 and neeed (AlphaTabApiBase), neeed (ISynthOutput), plus two code comments (differenciate in Environment, insturment in GpifSoundMapper). The matching generated/*Json.ts files were edited the same way so the tree stays consistent. No code changes.

Companion PR for the hand-written website pages: CoderLine/alphaTabWebsite#232.

Context: alphaTab is the engine behind Fretbox (iOS); the Expo bridge around it is published as expo-alphatab.

Checklist

  • I consent that this change becomes part of alphaTab under its current or any future open source license
  • This PR is linked to an accepted issue (see above)
  • Changes are implemented
  • New tests were added (comments only; nothing to test)
  • I have read AGENTS.md if an AI helped draft any part of this PR

AI authorship disclosure

  • No AI agent authored any part of this PR
  • An AI agent contributed to this PR. The AI-authored disclosure block (alphatab-ai-authored-v1) is present at the top of this body, and I have personally reviewed every change and can explain each one

Further details

  • This is a breaking change
  • This change will require update of the documentation/website

@github-actions

github-actions Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

Thanks for the pull request. Before we dig into the code, a couple of things need addressing in the description:

  • Keep the pull request template sections. The description is missing section: Root-cause analysis. Please include it — even a short answer keeps the report actionable.
  • Link the issue this addresses. Reference it in the description with Fixes #<n> (or Closes / Resolves) so the change can be traced back to the discussion we agreed on.

If the description isn't updated within 7 days, this pull request will be closed automatically and labeled state-rules-not-followed. Reopen any time — an edit to the description is all it takes.

If an AI helped draft this, AGENTS.md covers the same expectations from the AI side.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant