Misc doc changes (#291)

List of changes:

- Fix typos
- Remove empty tabs
- Use common source url
- Add changelog to html doc

Author: kianmeng

.github/workflows/ci.yml

@@ -55,7 +55,7 @@ jobs:
           mix local.hex --force
           mix deps.get
       - run: MYSQL_URL=root:root@mysql ECTO_ADAPTER=myxql mix test
-  
+
   test-mssql:
     runs-on: ubuntu-latest
 
@@ -73,7 +73,7 @@ jobs:
         mssql_version: ["2017-latest", "2019-latest"]
         otp: [22.1.7]
         elixir: [1.9.4]
-        
+
     env:
       ACCEPT_EULA: Y
       MIX_ENV: test
@@ -95,7 +95,7 @@ jobs:
       - run: |
           export PATH="/opt/mssql-tools/bin:$PATH"
           ECTO_ADAPTER=tds mix test
-          
+
   test-pg:
     runs-on: ubuntu-18.04
 

CHANGELOG.md

@@ -117,7 +117,7 @@
 ### Enhancements
 
   * [ecto] Upgrade and support Ecto v3.3
-  * [repo] Include `:idle_time` on telemetry measuremnts
+  * [repo] Include `:idle_time` on telemetry measurements
   * [migration] Support anonymous functions in `Ecto.Migration.execute/2`
 
 ### Bug fixes
@@ -216,7 +216,7 @@ v3.1 requires Elixir v1.5+.
   * [sandbox] Respect `:ownership_timeout` repo configuration on SQL Sandbox
   * [migrations] Commit and relock after every migration to avoid leaving the DB in an inconsistent state under certain failures
 
-### Backwards incompatible changess
+### Backwards incompatible changes
 
   * [migrations] If you are creating indexes concurrently, you need to disable the migration lock: `config :app, App.Repo, migration_lock: nil`. This will migrations behave the same way as they did in Ecto 2.0.
 

README.md

@@ -1,5 +1,6 @@
 Ecto SQL
 =========
+
 [![Build Status](https://github.com/elixir-ecto/ecto_sql/workflows/CI/badge.svg)](https://github.com/elixir-ecto/ecto_sql/actions)
 
 Ecto SQL ([documentation](https://hexdocs.pm/ecto_sql)) provides building blocks for writing SQL adapters for Ecto. It features:
@@ -9,7 +10,7 @@ Ecto SQL ([documentation](https://hexdocs.pm/ecto_sql)) provides building blocks
   * A test sandbox (Ecto.Adapters.SQL.Sandbox) that concurrently runs database tests inside transactions
   * Support for database migrations via Mix tasks
 
-To learn more about getting started, [see the Ecto repository](https://github.com/elixir-ecto/ecto). 
+To learn more about getting started, [see the Ecto repository](https://github.com/elixir-ecto/ecto).
 
 ## Running tests
 

lib/ecto/adapters/sql.ex

@@ -256,7 +256,7 @@ defmodule Ecto.Adapters.SQL do
       iex> Ecto.Adapters.SQL.explain(Repo, :all, Post, analyze: true, timeout: 20_000)
       "Seq Scan on posts p0  (cost=0.00..11.70 rows=170 width=443) (actual time=0.013..0.013 rows=0 loops=1)\\nPlanning Time: 0.031 ms\\nExecution Time: 0.021 ms"
 
-  It's safe to execute it for updates and deletes, no data change will be commited:
+  It's safe to execute it for updates and deletes, no data change will be committed:
 
       iex> Ecto.Adapters.SQL.explain(Repo, :update_all, from(p in Post, update: [set: [title: "new title"]]))
       "Update on posts p0  (cost=0.00..11.70 rows=170 width=449)\\n  ->  Seq Scan on posts p0  (cost=0.00..11.70 rows=170 width=449)"

lib/ecto/adapters/tds.ex

@@ -35,7 +35,7 @@ defmodule Ecto.Adapters.Tds do
 
       config :tds, :text_encoder, Tds.Encoding
 
-  This should give you extended set of most encoding. For cemplete list check
+  This should give you extended set of most encoding. For complete list check
   `Tds.Encoding` [documentation](https://hexdocs.pm/tds_encoding).
 
   ### After connect flags
@@ -66,7 +66,7 @@ defmodule Ecto.Adapters.Tds do
 
   ### SQL `Char`, `VarChar` and `Text` types
 
-  When working with binaries and strings,there are some limitions you should be aware of:
+  When working with binaries and strings,there are some limitations you should be aware of:
 
     - Strings that should be stored in mentioned sql types must be encoded to column
       codepage (defined in collation). If collation is different than database collation,
@@ -116,17 +116,17 @@ defmodule Ecto.Adapters.Tds do
 
   To avoid deadlocks in your app, we exposed `:isolation_level`  repo transaction option.
   This will tell to SQL Server Transaction Manager how to begin transaction.
-  By default, if this option is ommited, isolation level is set to `:read_committed`.
+  By default, if this option is omitted, isolation level is set to `:read_committed`.
 
-  Any attempt to manualy set the transaction isolation via queries, such as
+  Any attempt to manually set the transaction isolation via queries, such as
 
       Ecto.Adapter.SQL.query("SET TRANSACTION ISOLATION LEVEL XYZ")
 
   will fail once explicit transaction is started using `c:Ecto.Repo.transaction/2`
   and reset back to :read_commited.
 
   There is `Ecto.Query.lock/3` function can help by setting it to `WITH(NOLOCK)`.
-  This should allow you to do eventualy consistent reads and avoid locks on given
+  This should allow you to do eventually consistent reads and avoid locks on given
   table if you don't need to write to database.
 
   NOTE: after explicit transaction ends (commit or rollback) implicit transactions
@@ -215,7 +215,7 @@ defmodule Ecto.Adapters.Tds do
   @impl Ecto.Adapter.Storage
   def storage_status(opts) do
     database =
-      Keyword.fetch!(opts, :database) || raise ":database is nil in repostory configuration"
+      Keyword.fetch!(opts, :database) || raise ":database is nil in repository configuration"
 
     opts = Keyword.put(opts, :database, "master")
 

lib/ecto/adapters/tds/types.ex

@@ -225,7 +225,7 @@ if Code.ensure_loaded?(Tds) do
 
   defmodule Tds.Ecto.VarChar do
     @moduledoc """
-    An Tds adatper Ecto Type that wrapps erlang string into tuple so TDS driver
+    An Tds adapter Ecto Type that wraps erlang string into tuple so TDS driver
     can understand if erlang string should be encoded as NVarChar or Varchar.
 
     Due some limitations in Ecto and Tds driver, it is not possible to

lib/ecto/migration.ex

@@ -282,7 +282,7 @@ defmodule Ecto.Migration do
   but not true for MySQL, as the latter does not support DDL transactions.
 
   In some rare cases, you may need to execute some common behavior after beginning
-  a migration transaction, or before commiting that transaction. For instance, one
+  a migration transaction, or before committing that transaction. For instance, one
   might desire to set a `lock_timeout` for each lock in the migration transaction.
 
   You can do so by defining `c:after_begin/0` and `c:before_commit/0` callbacks to

mix.exs

@@ -1,6 +1,7 @@
 defmodule EctoSQL.MixProject do
   use Mix.Project
 
+  @source_url "https://github.com/elixir-ecto/ecto_sql"
   @version "3.6.0-dev"
   @adapters ~w(pg myxql tds)
 
@@ -112,7 +113,7 @@ defmodule EctoSQL.MixProject do
     [
       maintainers: ["Eric Meadows-Jönsson", "José Valim", "James Fish", "Michał Muskała"],
       licenses: ["Apache-2.0"],
-      links: %{"GitHub" => "https://github.com/elixir-ecto/ecto_sql"},
+      links: %{"GitHub" => @source_url},
       files:
         ~w(.formatter.exs mix.exs README.md CHANGELOG.md lib) ++
           ~w(integration_test/sql integration_test/support)
@@ -173,7 +174,9 @@ defmodule EctoSQL.MixProject do
       main: "Ecto.Adapters.SQL",
       source_ref: "v#{@version}",
       canonical: "http://hexdocs.pm/ecto_sql",
-      source_url: "https://github.com/elixir-ecto/ecto_sql",
+      source_url: @source_url,
+      extras: ["CHANGELOG.md"],
+      skip_undefined_reference_warnings_on: ["CHANGELOG.md"],
       groups_for_modules: [
         # Ecto.Adapters.SQL,
         # Ecto.Adapters.SQL.Sandbox,