Skip to content

Fix typos and broken links in docs, changelogs and build config - #3857

Closed
olitreadwell wants to merge 1 commit into
simolus3:developfrom
olitreadwell:docs/fix-more-doc-typos
Closed

olitreadwell wants to merge 1 commit into
simolus3:developfrom
olitreadwell:docs/fix-more-doc-typos

Conversation

@olitreadwell

Copy link
Copy Markdown
Contributor

What changed

Fix several typos and two broken links across the docs, changelogs and build config.

  • thats becomes that's in the drift file API docs.
  • Encode the parentheses in the Wikipedia "Window function" link so it resolves (it currently 404s).
  • Point the "older version of Electric SQL" note at the live electric-sql.com URL, since the legacy subdomain no longer serves the site.
  • Fix compatiblity in the drift changelog and whereever, unecessary, correclty in the drift_dev changelog.
  • Fix unecessary in the sqlparser changelog.
  • Fix Exlude to Exclude in the drift build and test configs.

Why

All changes are meaning-preserving trivial fixes from a cleanup pass over the repo.
The Wikipedia link genuinely 404s because its closing parenthesis is missing, and the legacy.electric-sql.com link no longer loads.
The other changes are plain misspellings in user-facing docs, changelogs and build-config comments.

How to verify

git fetch https://github.com/olitreadwell/drift.git docs/fix-more-doc-typos
git checkout FETCH_HEAD
dart format -o none --set-exit-if-changed .
dart analyze --fatal-infos --fatal-warnings
dart test

@simolus3 simolus3 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thanks!

### Window functions

In addition to aggregate expressions and `groupBy`, drift supports [window functions](https://en.wikipedia.org/wiki/Window_function_(SQL)).
In addition to aggregate expressions and `groupBy`, drift supports [window functions](https://en.wikipedia.org/wiki/Window_function_%28SQL%29).

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

The link as rendered on the website works for me.

!!! note "This section may be outdated"

The Dart package for Electric referenced here refers to an [older version of Electric SQL](https://legacy.electric-sql.com/),
The Dart package for Electric referenced here refers to an [older version of Electric SQL](https://electric-sql.com/),

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Even the new ElectricSQL is kind of dead at this point, so we should probably just remove the entire section.

@simolus3

Copy link
Copy Markdown
Owner

Merged in 00d2f2e, thanks!

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