From 2ac362de9ac0882a19ff32f3857e1ec2fa886832 Mon Sep 17 00:00:00 2001 From: Guillaume Dalle <22795598+gdalle@users.noreply.github.com> Date: Sat, 30 Sep 2023 18:54:53 +0200 Subject: [PATCH] Oops forgot some stuff --- docs/make.jl | 2 +- docs/src/animals.md | 4 ++-- src/Interfaces.jl | 7 +++++-- test/animals.jl | 4 ++-- 4 files changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index ff699df..515c7cd 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -32,7 +32,7 @@ makedocs(; "Home" => "index.md", "API reference" => "api.md", "Examples" => [ - "Single argument" => "animals.md", + "Basic" => "animals.md", ] ], ) diff --git a/docs/src/animals.md b/docs/src/animals.md index 9f2d9ac..fde7e42 100644 --- a/docs/src/animals.md +++ b/docs/src/animals.md @@ -2,9 +2,9 @@ EditURL = "../../test/animals.jl" ``` -# Single-argument interface +# Basic -Here's an examples using animals, and the implementation of a duck. +Here's an example of single-argument interface using animals, and the implementation of a duck. ## Definition diff --git a/src/Interfaces.jl b/src/Interfaces.jl index 00fedd8..8f7da5b 100644 --- a/src/Interfaces.jl +++ b/src/Interfaces.jl @@ -1,6 +1,9 @@ -module Interfaces +""" + Interfaces -@doc read(joinpath(dirname(@__DIR__), "README.md"), String) Interfaces +A Julia package for specifying and testing interfaces (conditions verified by a set of methods applied to a type). +""" +module Interfaces export @implements, @interface diff --git a/test/animals.jl b/test/animals.jl index 868f8c3..3b6affb 100644 --- a/test/animals.jl +++ b/test/animals.jl @@ -1,6 +1,6 @@ -# # Single-argument interface +# # Basic -# Here's an examples using animals, and the implementation of a duck. +# Here's an example of single-argument interface using animals, and the implementation of a duck. # ## Definition