Skip to content

Commit b486af5

Browse files
fahchenclaude
andcommitted
chore: update dprint markdown formatter and adjust doc formatting
- Update dprint_markdown_formatter from 0.3.0 to 0.5.1 - Change @doc strings to sigil format for compatibility - Restrict markdown formatting to root-level files only 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent c3bb56f commit b486af5

5 files changed

Lines changed: 9 additions & 9 deletions

File tree

.formatter.exs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
locals_without_parens = [colset: 1, var: 1, val: 1, return: 1]
22

33
[
4-
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}", "**/*.md"],
4+
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}", "*.md"],
55
import_deps: [:typed_structor, :ecto, :ecto_sql],
66
locals_without_parens: locals_without_parens,
77
plugins: [DprintMarkdownFormatter],

lib/coloured_flow/expression/expression.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ defmodule ColouredFlow.Expression do
77
alias ColouredFlow.Expression.EvalDiagnostic
88
alias ColouredFlow.Expression.Scope
99

10-
@doc """
10+
@doc ~S'''
1111
Converts a string to a quoted expression and returns its ast and the unbound
1212
variables.
1313
@@ -21,7 +21,7 @@ defmodule ColouredFlow.Expression do
2121
...> fun.(a)
2222
...> """)
2323
iex> %{a: [[line: 2, column: 6]], b: [[line: 1, column: 19]]} = unbound_vars
24-
"""
24+
'''
2525

2626
@typedoc """
2727
The error that is returned when the string can't be converted to a quoted

lib/coloured_flow/notation/declaration.ex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ defmodule ColouredFlow.Notation.Declaration do
77
alias ColouredFlow.Definition.Constant
88
alias ColouredFlow.Definition.Variable
99

10-
@doc """
10+
@doc ~S'''
1111
Compile a block string of ColouredFlow declarations into a list of definitions.
1212
1313
## Example:
1414
15-
iex> ColouredFlow.Notation.Declaration.compile(~S"""
15+
iex> ColouredFlow.Notation.Declaration.compile("""
1616
...> colset name :: binary()
1717
...> var name :: name()
1818
...> val name :: name() = "Alice"
@@ -22,7 +22,7 @@ defmodule ColouredFlow.Notation.Declaration do
2222
%ColouredFlow.Definition.Variable{name: :name, colour_set: :name},
2323
%ColouredFlow.Definition.Constant{name: :name, colour_set: :name, value: "Alice"}
2424
]}
25-
"""
25+
'''
2626
@spec compile(inscription :: binary()) ::
2727
{:ok, [ColourSet.t() | Constant.t() | Variable.t()]}
2828
| {:error, [Exception.t()]}

mix.exs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ defmodule ColouredFlow.MixProject do
3737
[
3838
{:credo, "~> 1.6", only: [:dev, :test], runtime: false},
3939
{:dialyxir, "~> 1.0", only: [:dev], runtime: false},
40-
{:dprint_markdown_formatter, "~> 0.3.0", only: [:dev, :test], runtime: false},
40+
{:dprint_markdown_formatter, "~> 0.5.1", only: [:dev, :test], runtime: false},
4141
{:ecto, "~> 3.0"},
4242
{:ecto_sql, "~> 3.12"},
4343
{:ex_doc, "~> 0.31", only: :dev, runtime: false},

mix.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"db_connection": {:hex, :db_connection, "2.7.0", "b99faa9291bb09892c7da373bb82cba59aefa9b36300f6145c5f201c7adf48ec", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "dcf08f31b2701f857dfc787fbad78223d61a32204f217f15e881dd93e4bdd3ff"},
66
"decimal": {:hex, :decimal, "2.1.1", "5611dca5d4b2c3dd497dec8f68751f1f1a54755e8ed2a966c2633cf885973ad6", [:mix], [], "hexpm", "53cfe5f497ed0e7771ae1a475575603d77425099ba5faef9394932b35020ffcc"},
77
"dialyxir": {:hex, :dialyxir, "1.4.3", "edd0124f358f0b9e95bfe53a9fcf806d615d8f838e2202a9f430d59566b6b53b", [:mix], [{:erlex, ">= 0.2.6", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "bf2cfb75cd5c5006bec30141b131663299c661a864ec7fbbc72dfa557487a986"},
8-
"dprint_markdown_formatter": {:hex, :dprint_markdown_formatter, "0.3.0", "fc3ec2cda585a51623a31e55558d6fd26f4b2ec8f1af9ef8a107f4df8cec9ac5", [:mix], [{:rustler, "~> 0.36.0", [hex: :rustler, repo: "hexpm", optional: true]}, {:rustler_precompiled, "~> 0.8", [hex: :rustler_precompiled, repo: "hexpm", optional: false]}, {:sourceror, "~> 1.0", [hex: :sourceror, repo: "hexpm", optional: false]}, {:typed_structor, "~> 0.5.0", [hex: :typed_structor, repo: "hexpm", optional: false]}], "hexpm", "d79ec7daa0a0c84e633ab6357f9682841fcb450f105103256d5ca7d42a172e00"},
8+
"dprint_markdown_formatter": {:hex, :dprint_markdown_formatter, "0.5.1", "8e056b7f1289568013e399deece30df0da315fca8675625d1be43e83e56e9f61", [:mix], [{:rustler, "~> 0.36.0", [hex: :rustler, repo: "hexpm", optional: true]}, {:rustler_precompiled, "~> 0.8", [hex: :rustler_precompiled, repo: "hexpm", optional: false]}, {:sourceror, "~> 1.0", [hex: :sourceror, repo: "hexpm", optional: false]}, {:typed_structor, "~> 0.5.0", [hex: :typed_structor, repo: "hexpm", optional: false]}], "hexpm", "26439349849f42e5d33f08170a8fefc33e8ba5bd3f040cfc93be11d63dd8d35c"},
99
"earmark_parser": {:hex, :earmark_parser, "1.4.41", "ab34711c9dc6212dda44fcd20ecb87ac3f3fce6f0ca2f28d4a00e4154f8cd599", [:mix], [], "hexpm", "a81a04c7e34b6617c2792e291b5a2e57ab316365c2644ddc553bb9ed863ebefa"},
1010
"ecto": {:hex, :ecto, "3.12.3", "1a9111560731f6c3606924c81c870a68a34c819f6d4f03822f370ea31a582208", [:mix], [{:decimal, "~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "9efd91506ae722f95e48dc49e70d0cb632ede3b7a23896252a60a14ac6d59165"},
1111
"ecto_sql": {:hex, :ecto_sql, "3.12.0", "73cea17edfa54bde76ee8561b30d29ea08f630959685006d9c6e7d1e59113b7d", [:mix], [{:db_connection, "~> 2.4.1 or ~> 2.5", [hex: :db_connection, repo: "hexpm", optional: false]}, {:ecto, "~> 3.12", [hex: :ecto, repo: "hexpm", optional: false]}, {:myxql, "~> 0.7", [hex: :myxql, repo: "hexpm", optional: true]}, {:postgrex, "~> 0.19 or ~> 1.0", [hex: :postgrex, repo: "hexpm", optional: true]}, {:tds, "~> 2.1.1 or ~> 2.2", [hex: :tds, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4.0 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "dc9e4d206f274f3947e96142a8fdc5f69a2a6a9abb4649ef5c882323b6d512f0"},
@@ -22,7 +22,7 @@
2222
"makeup_erlang": {:hex, :makeup_erlang, "1.0.1", "c7f58c120b2b5aa5fd80d540a89fdf866ed42f1f3994e4fe189abebeab610839", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "8a89a1eeccc2d798d6ea15496a6e4870b75e014d1af514b1b71fa33134f57814"},
2323
"nimble_parsec": {:hex, :nimble_parsec, "1.4.0", "51f9b613ea62cfa97b25ccc2c1b4216e81df970acd8e16e8d1bdc58fef21370d", [:mix], [], "hexpm", "9c565862810fb383e9838c1dd2d7d2c437b3d13b267414ba6af33e50d2d1cf28"},
2424
"postgrex": {:hex, :postgrex, "0.19.1", "73b498508b69aded53907fe48a1fee811be34cc720e69ef4ccd568c8715495ea", [:mix], [{:db_connection, "~> 2.1", [hex: :db_connection, repo: "hexpm", optional: false]}, {:decimal, "~> 1.5 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:table, "~> 0.1.0", [hex: :table, repo: "hexpm", optional: true]}], "hexpm", "8bac7885a18f381e091ec6caf41bda7bb8c77912bb0e9285212829afe5d8a8f8"},
25-
"rustler_precompiled": {:hex, :rustler_precompiled, "0.8.2", "5f25cbe220a8fac3e7ad62e6f950fcdca5a5a5f8501835d2823e8c74bf4268d5", [:mix], [{:castore, "~> 0.1 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: false]}, {:rustler, "~> 0.23", [hex: :rustler, repo: "hexpm", optional: true]}], "hexpm", "63d1bd5f8e23096d1ff851839923162096364bac8656a4a3c00d1fff8e83ee0a"},
25+
"rustler_precompiled": {:hex, :rustler_precompiled, "0.8.3", "4e741024b0b097fe783add06e53ae9a6f23ddc78df1010f215df0c02915ef5a8", [:mix], [{:castore, "~> 0.1 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: false]}, {:rustler, "~> 0.23", [hex: :rustler, repo: "hexpm", optional: true]}], "hexpm", "c23f5f33cb6608542de4d04faf0f0291458c352a4648e4d28d17ee1098cddcc4"},
2626
"sourceror": {:hex, :sourceror, "1.10.0", "38397dedbbc286966ec48c7af13e228b171332be1ad731974438c77791945ce9", [:mix], [], "hexpm", "29dbdfc92e04569c9d8e6efdc422fc1d815f4bd0055dc7c51b8800fb75c4b3f1"},
2727
"table": {:hex, :table, "0.1.2", "87ad1125f5b70c5dea0307aa633194083eb5182ec537efc94e96af08937e14a8", [:mix], [], "hexpm", "7e99bc7efef806315c7e65640724bf165c3061cdc5d854060f74468367065029"},
2828
"telemetry": {:hex, :telemetry, "1.3.0", "fedebbae410d715cf8e7062c96a1ef32ec22e764197f70cda73d82778d61e7a2", [:rebar3], [], "hexpm", "7015fc8919dbe63764f4b4b87a95b7c0996bd539e0d499be6ec9d7f3875b79e6"},

0 commit comments

Comments
 (0)