From 3f0545b98c0cef6c13e0849aa622a7d28cb6247a Mon Sep 17 00:00:00 2001
From: guoye <498731903@qq.com>
Date: Fri, 5 Jun 2020 16:33:49 +0800
Subject: [PATCH] fix doc

---
 doc/source/index.rst                                       | 2 +-
 doc/source/{jittor.compile_extern.mpi.md => jittor.mpi.md} | 2 +-
 extern/mpi/inc/mpi_warper.h                                | 1 +
 3 files changed, 3 insertions(+), 2 deletions(-)
 rename doc/source/{jittor.compile_extern.mpi.md => jittor.mpi.md} (91%)

diff --git a/doc/source/index.rst b/doc/source/index.rst
index a425c4dd..90cd7cd9 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -24,7 +24,7 @@
    jittor.contrib
    jittor.dataset
    jittor.transform
-   jittor.compile_extern.mpi
+   jittor.mpi
 
 
 .. toctree::
diff --git a/doc/source/jittor.compile_extern.mpi.md b/doc/source/jittor.mpi.md
similarity index 91%
rename from doc/source/jittor.compile_extern.mpi.md
rename to doc/source/jittor.mpi.md
index 1c705744..a0da9183 100644
--- a/doc/source/jittor.compile_extern.mpi.md
+++ b/doc/source/jittor.mpi.md
@@ -1,4 +1,4 @@
-jittor.compile_extern.mpi
+jittor.mpi
 =====================
 
 这里是Jittor的MPI模块的API文档，您可以通过`from jittor.compile_extern import mpi`来获取该模块。
diff --git a/extern/mpi/inc/mpi_warper.h b/extern/mpi/inc/mpi_warper.h
index 4ec66591..e5094827 100644
--- a/extern/mpi/inc/mpi_warper.h
+++ b/extern/mpi/inc/mpi_warper.h
@@ -53,6 +53,7 @@ struct ArrayArgs;
 
 Use jt.Module.mpi_param_broadcast(root=0) to broadcast all moudule parameters of this module in [root] MPI node to all MPI nodes.
 
+This operation has no gradient, and the input parameter type is numpy array.
 */
 // @pyjt(broadcast)
 void _mpi_broadcast(ArrayArgs&& args, int root);