Mark protocols setters as doc(hidden)

PyO3 · Jun 16, 2020 · 2a69367 · 2a69367
1 parent f7fa008
commit 2a69367
Show file tree

Hide file tree

Showing 9 changed files with 12 additions and 1 deletion.
diff --git a/src/class/basic.rs b/src/class/basic.rs
@@ -153,6 +153,7 @@ pub struct PyObjectMethods {
     pub nb_bool: Option<ffi::inquiry>,
 }
 
+#[doc(hidden)]
 impl PyObjectMethods {
     pub(crate) fn update_typeobj(&self, type_object: &mut ffi::PyTypeObject) {
         type_object.tp_str = self.tp_str;
@@ -162,7 +163,7 @@ impl PyObjectMethods {
         type_object.tp_richcompare = self.tp_richcompare;
         type_object.tp_setattro = self.tp_setattro;
     }
-
+    // Set functions used by `#[pyproto]`.
     pub fn set_str<T>(&mut self)
     where
         T: for<'p> PyObjectStrProtocol<'p>,

diff --git a/src/class/buffer.rs b/src/class/buffer.rs
@@ -40,6 +40,8 @@ pub trait PyBufferReleaseBufferProtocol<'p>: PyBufferProtocol<'p> {
     type Result: Into<PyResult<()>>;
 }
 
+/// Set functions used by `#[pyproto]`.
+#[doc(hidden)]
 impl PyBufferProcs {
     pub fn set_getbuffer<T>(&mut self)
     where

diff --git a/src/class/descr.rs b/src/class/descr.rs
@@ -71,12 +71,14 @@ pub trait PyDescrSetNameProtocol<'p>: PyDescrProtocol<'p> {
     type Result: Into<PyResult<()>>;
 }
 
+/// All FFI functions for description protocols.
 #[derive(Default)]
 pub struct PyDescrMethods {
     pub tp_descr_get: Option<ffi::descrgetfunc>,
     pub tp_descr_set: Option<ffi::descrsetfunc>,
 }
 
+#[doc(hidden)]
 impl PyDescrMethods {
     pub(crate) fn update_typeobj(&self, type_object: &mut ffi::PyTypeObject) {
         type_object.tp_descr_get = self.tp_descr_get;

diff --git a/src/class/gc.rs b/src/class/gc.rs
@@ -25,6 +25,7 @@ pub struct PyGCMethods {
     pub tp_clear: Option<ffi::inquiry>,
 }
 
+#[doc(hidden)]
 impl PyGCMethods {
     pub(crate) fn update_typeobj(&self, type_object: &mut ffi::PyTypeObject) {
         type_object.tp_traverse = self.tp_traverse;

diff --git a/src/class/iter.rs b/src/class/iter.rs
@@ -46,6 +46,7 @@ pub struct PyIterMethods {
     pub tp_iternext: Option<ffi::iternextfunc>,
 }
 
+#[doc(hidden)]
 impl PyIterMethods {
     pub(crate) fn update_typeobj(&self, type_object: &mut ffi::PyTypeObject) {
         type_object.tp_iter = self.tp_iter;

diff --git a/src/class/mapping.rs b/src/class/mapping.rs
@@ -74,6 +74,7 @@ pub trait PyMappingReversedProtocol<'p>: PyMappingProtocol<'p> {
     type Result: Into<PyResult<Self::Success>>;
 }
 
+#[doc(hidden)]
 impl ffi::PyMappingMethods {
     pub fn set_length<T>(&mut self)
     where

diff --git a/src/class/number.rs b/src/class/number.rs
@@ -615,6 +615,7 @@ pub trait PyNumberIndexProtocol<'p>: PyNumberProtocol<'p> {
     type Result: Into<PyResult<Self::Success>>;
 }
 
+#[doc(hidden)]
 impl ffi::PyNumberMethods {
     pub(crate) fn from_nb_bool(nb_bool: ffi::inquiry) -> *mut Self {
         let mut nm = ffi::PyNumberMethods_INIT;

diff --git a/src/class/pyasync.rs b/src/class/pyasync.rs
@@ -89,6 +89,7 @@ pub trait PyAsyncAexitProtocol<'p>: PyAsyncProtocol<'p> {
     type Result: Into<PyResult<Self::Success>>;
 }
 
+#[doc(hidden)]
 impl ffi::PyAsyncMethods {
     pub fn set_await<T>(&mut self)
     where

diff --git a/src/class/sequence.rs b/src/class/sequence.rs
@@ -126,6 +126,7 @@ pub trait PySequenceInplaceRepeatProtocol<'p>: PySequenceProtocol<'p> + IntoPy<P
     type Result: Into<PyResult<Self>>;
 }
 
+#[doc(hidden)]
 impl ffi::PySequenceMethods {
     pub fn set_len<T>(&mut self)
     where