Oops forgot some stuff

rafaqz · Sep 30, 2023 · 2ac362d · 2ac362d
1 parent 0f2e22b
commit 2ac362d
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 7 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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