CDRIVER-2152 mistakes in GridFS file docs

ajdavis · ajdavis · commit 354f3be78c0a · 2017-11-20T11:06:47.000-05:00
diff --git a/doc/api.rst b/doc/api.rst
@@ -43,7 +43,6 @@ API Reference
    mongoc_ssl_opt_t
    mongoc_stream_buffered_t
    mongoc_stream_file_t
-   mongoc_stream_gridfs_t
    mongoc_stream_socket_t
    mongoc_stream_t
    mongoc_stream_tls_t
diff --git a/doc/mongoc_gridfs_file_t.rst b/doc/mongoc_gridfs_file_t.rst
@@ -56,6 +56,7 @@ This structure is NOT thread-safe and should only be used from one thread at a t
     mongoc_gridfs_file_set_metadata
     mongoc_gridfs_file_tell
     mongoc_gridfs_file_writev
+    mongoc_stream_gridfs_new
 
 Related
 -------
diff --git a/doc/mongoc_stream_gridfs_new.rst b/doc/mongoc_stream_gridfs_new.rst
@@ -16,10 +16,11 @@ Parameters
 
 * ``file``: A :symbol:`mongoc_gridfs_file_t`.
 
-This function shall create a new :symbol:`mongoc_gridfs_file_t`. This function does not transfer ownership of ``file``. Therefore, ``file`` must remain valid for the lifetime of this stream.
+This function shall create a new :symbol:`mongoc_stream_t` to read from and write to a GridFS file. GridFS files are created with :symbol:`mongoc_gridfs_create_file` or :symbol:`mongoc_gridfs_create_file_from_stream`.
+
+This function does not transfer ownership of ``file``. Therefore, ``file`` must remain valid for the lifetime of this stream.
 
 Returns
 -------
 
-A newly allocated :symbol:`mongoc_stream_gridfs_t` if successful, otherwise ``NULL``.
-
+A newly allocated :symbol:`mongoc_stream_t` if successful, otherwise ``NULL``.
diff --git a/doc/mongoc_stream_gridfs_t.rst b/doc/mongoc_stream_gridfs_t.rst
diff --git a/doc/mongoc_stream_t.rst b/doc/mongoc_stream_t.rst
@@ -52,6 +52,3 @@ See Also
 :doc:`mongoc_stream_socket_t`
 
 :doc:`mongoc_stream_tls_t`
-
-:doc:`mongoc_stream_gridfs_t`
-
