Fix documentation links

lukstafi · lukstafi · commit 22552341f230 · 2025-04-08T11:20:44.000+02:00
Signed-off-by: Lukasz Stafiniak &lt;lukstafi@gmail.com&gt;
diff --git a/arrayjit/lib/backend_impl.ml b/arrayjit/lib/backend_impl.ml
@@ -141,10 +141,11 @@ struct
     { stream = parent.stream; parent = Some parent; ctx_arrays; finalized = Atomic.make false }
 end
 
-(** Parts shared by backend implementations excluding what's already in {!Backend_any_common},
-    except for {!Buffer} which is duplicated for technical reasons. *)
+(** Parts shared by backend implementations excluding what's already in
+    {!Backend_intf.Backend_any_common}, except for {!Backend_intf.Buffer} which is duplicated for
+    technical reasons. *)
 module type Backend_impl_common = sig
-  include Buffer
+  include Backend_intf.Buffer
 
   val use_host_memory : (unit Ctypes.ptr -> buffer_ptr) option
   (** If not [None], the backend will read from and write to the host memory directly whenever
@@ -197,10 +198,11 @@ module type No_buffer_retrieval_or_syncing = sig
   include Backend_device_common with type buffer_ptr := buffer_ptr
 
   val from_host : dst_ptr:buffer_ptr -> dst:context -> Ndarray.t -> unit
-  (** Like {!Backend.from_host}, but without synchronization and buffer retrieval. *)
+  (** Like {!Backend_intf.Backend.from_host}, but without synchronization and buffer retrieval. *)
 
   val to_host : src_ptr:buffer_ptr -> src:context -> Ndarray.t -> unit
-  (** Like {!Backend.to_host}, but without synchronization events and buffer retrieval. *)
+  (** Like {!Backend_intf.Backend.to_host}, but without synchronization events and buffer retrieval.
+  *)
 
   val device_to_device :
     Tnode.t ->
@@ -210,8 +212,8 @@ module type No_buffer_retrieval_or_syncing = sig
     src_ptr:buffer_ptr ->
     src:context ->
     unit
-  (** Like {!Backend.device_to_device}, but without synchronization events and buffer retrieval.
-      Raises [Invalid_argument] if [into_merge_buffer = No] and [dst_ptr = None]. *)
+  (** Like {!Backend_intf.Backend.device_to_device}, but without synchronization events and buffer
+      retrieval. Raises [Invalid_argument] if [into_merge_buffer = No] and [dst_ptr = None]. *)
 end
 
 (** An intermediate stage for converting {!Lowered_no_device_backend} backends into
diff --git a/arrayjit/lib/backend_intf.ml b/arrayjit/lib/backend_intf.ml
@@ -199,8 +199,9 @@ module type Device = sig
   (** Returns a context without a parent. *)
 
   val make_child : ?ctx_arrays:ctx_arrays -> context -> context
-  (** Returns a context with the same {!field:stream}, and {!field:ctx_arrays} if omitted, as the
-      given context's, which is also the {!field:parent}. *)
+  (** Returns a context with the same {!field:Backend_intf.context.stream}, and
+      {!field:Backend_intf.context.ctx_arrays} if omitted, as the given context's, which is also the
+      {!field:Backend_intf.context.parent}. *)
 
   val get_name : stream -> string
 end
@@ -290,7 +291,8 @@ module type Backend_device_common = sig
   val num_devices : unit -> int
 
   val suggested_num_streams : device -> int
-  (** The optimal number of streams for the given device to follow the {!type:config} strategy. *)
+  (** The optimal number of streams for the given device to follow the {!type:Backend_intf.config}
+      strategy. *)
 
   val new_stream : device -> stream
 end
diff --git a/arrayjit/lib/backends.mli b/arrayjit/lib/backends.mli
@@ -19,5 +19,5 @@ val finalize :
 
 val fresh_backend : ?backend_name:string -> unit -> (module Backend_intf.Backend)
 (** Creates a new backend corresponding to [backend_name], or if omitted, selected via the global
-    [backend] setting. It should be safe to call {!Tensor.unsafe_reinitialize} before
+    [backend] setting. It should be safe to reinitialize the tensor system before
     [fresh_backend]. *)
diff --git a/lib/shape.mli b/lib/shape.mli
@@ -83,7 +83,7 @@ type transpose_type =
   | Batch_slice of Arrayjit.Indexing.static_symbol  (** Removes the leftmost batch axis. *)
 [@@deriving equal, sexp]
 
-(** If you miss expressivity here, leave a note on {!{https://github.com/ahrefs/ocannl/issues/305}issue 305}. *)
+(** If you miss expressivity here, leave a note on {{:https://github.com/ahrefs/ocannl/issues/305}issue 305}. *)
 type ternary_type =
   | Pointwise_tern  (** As in the operation [Where]. *)
   | Compose_accumulate  (** As in the operation [FMA]. *)
