Skip to content
This repository has been archived by the owner on Sep 19, 2023. It is now read-only.

Deprecate docception #12

Merged
merged 1 commit into from
Sep 19, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,25 @@

Run doctests on arbitrary markdown files.

## DEPRECATION NOTICE

As of Elixir 1.15, this dependency can be replaced by using the
[doctest_file/1,2](https://hexdocs.pm/ex_unit/1.15/ExUnit.DocTest.html#doctest_file/2) macro
provided by ExUnit itself, see #11 (thanks @axelson for pointing this out). To use this
on a range of files, you can create a simple test module in your `test/` directory:

```elixir
defmodule DocTest do
use ExUnit.Case
# You could also use a wildcard below
for file <- ["README.md"] do
doctest_file(file)
end
end
```

---

## Usage

$ mix docception markdown-files
Expand Down