update BaseInterfaces docs (#51)

rafaqz · Jul 15, 2024 · d36fcdc · d36fcdc
1 parent 61f3365
commit d36fcdc
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 16 deletions.
diff --git a/docs/src/baseinterfaces.jl b/docs/src/baseinterfaces.jl
diff --git a/docs/src/baseinterfaces.md b/docs/src/baseinterfaces.md
@@ -1,12 +1,25 @@
 # BaseInterfaces reference
 
-## Docstrings
+BaseInterfaces.jl is a work-in-progress package to define
+the major base julia interfaces in Interfaces.jl syntax.
 
-```@autodocs
-Modules = [BaseInterfaces]
-```
+As many of these are not actually clarified yet, even in docstrings,
+this is a difficult task and can't be 100% reliable.
+
+But at least trying is worthwhile to get the ball rolling.
+
+If you would like this interface to be more useful, and actually 
+registered, please contribute tests to the interface specs and new 
+interface we have not yet defined.
 
 ## Index
 
 ```@index
+Modules = [BaseInterfaces]
+```
+
+## Docstrings
+
+```@autodocs
+Modules = [BaseInterfaces]
 ```