Skip to content

Commit 0b80af3

Browse files
committed
Remove doc(hidden) attr from items in trait impls (#1165)
These attributes produce warnings like the following on nightly: ``` warning: `#[doc(hidden)]` is ignored on trait impl items --> src/indexes.rs:212:5 | 212 | #[doc(hidden)] | ^^^^^^^^^^^^^^ help: remove this attribute | = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release! = note: whether the impl item is `doc(hidden)` or not entirely depends on the corresponding trait item ``` I verified that these attributes have no effect on stable (1.60.0) or nightly (2022-05-16), so they can be safely removed.
1 parent 3c92c51 commit 0b80af3

File tree

6 files changed

+14
-64
lines changed

6 files changed

+14
-64
lines changed

src/data_traits.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -630,7 +630,6 @@ where
630630
}
631631
}
632632

633-
#[doc(hidden)]
634633
unsafe fn clone_from_with_ptr(
635634
&mut self,
636635
other: &Self,

src/indexes.rs

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -180,22 +180,18 @@ impl<D: Dimension + Copy> NdProducer for Indices<D> {
180180

181181
private_impl! {}
182182

183-
#[doc(hidden)]
184183
fn raw_dim(&self) -> Self::Dim {
185184
self.dim
186185
}
187186

188-
#[doc(hidden)]
189187
fn equal_dim(&self, dim: &Self::Dim) -> bool {
190188
self.dim.equal(dim)
191189
}
192190

193-
#[doc(hidden)]
194191
fn as_ptr(&self) -> Self::Ptr {
195192
IndexPtr { index: self.start }
196193
}
197194

198-
#[doc(hidden)]
199195
fn layout(&self) -> Layout {
200196
if self.dim.ndim() <= 1 {
201197
Layout::one_dimensional()
@@ -204,19 +200,16 @@ impl<D: Dimension + Copy> NdProducer for Indices<D> {
204200
}
205201
}
206202

207-
#[doc(hidden)]
208203
unsafe fn as_ref(&self, ptr: Self::Ptr) -> Self::Item {
209204
ptr.index.into_pattern()
210205
}
211206

212-
#[doc(hidden)]
213207
unsafe fn uget_ptr(&self, i: &Self::Dim) -> Self::Ptr {
214208
let mut index = *i;
215209
index += &self.start;
216210
IndexPtr { index }
217211
}
218212

219-
#[doc(hidden)]
220213
fn stride_of(&self, axis: Axis) -> Self::Stride {
221214
axis.index()
222215
}
@@ -226,7 +219,6 @@ impl<D: Dimension + Copy> NdProducer for Indices<D> {
226219
0
227220
}
228221

229-
#[doc(hidden)]
230222
fn split_at(self, axis: Axis, index: usize) -> (Self, Self) {
231223
let start_a = self.start;
232224
let mut start_b = start_a;

src/iterators/macros.rs

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,42 +63,34 @@ impl<$($typarm)*> NdProducer for $fulltype {
6363
type Ptr = *mut A;
6464
type Stride = isize;
6565

66-
#[doc(hidden)]
6766
fn raw_dim(&self) -> D {
6867
self.$base.raw_dim()
6968
}
7069

71-
#[doc(hidden)]
7270
fn layout(&self) -> Layout {
7371
self.$base.layout()
7472
}
7573

76-
#[doc(hidden)]
7774
fn as_ptr(&self) -> *mut A {
7875
self.$base.as_ptr() as *mut _
7976
}
8077

81-
#[doc(hidden)]
8278
fn contiguous_stride(&self) -> isize {
8379
self.$base.contiguous_stride()
8480
}
8581

86-
#[doc(hidden)]
8782
unsafe fn as_ref(&$self_, $ptr: *mut A) -> Self::Item {
8883
$refexpr
8984
}
9085

91-
#[doc(hidden)]
9286
unsafe fn uget_ptr(&self, i: &Self::Dim) -> *mut A {
9387
self.$base.uget_ptr(i)
9488
}
9589

96-
#[doc(hidden)]
9790
fn stride_of(&self, axis: Axis) -> isize {
9891
self.$base.stride_of(axis)
9992
}
10093

101-
#[doc(hidden)]
10294
fn split_at(self, axis: Axis, index: usize) -> (Self, Self) {
10395
let (a, b) = self.$base.split_at(axis, index);
10496
($typename {
@@ -114,6 +106,7 @@ impl<$($typarm)*> NdProducer for $fulltype {
114106
)*
115107
})
116108
}
109+
117110
private_impl!{}
118111
}
119112

src/iterators/mod.rs

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1105,15 +1105,14 @@ impl<'a, A, D: Dimension> NdProducer for AxisIter<'a, A, D> {
11051105
type Ptr = *mut A;
11061106
type Stride = isize;
11071107

1108-
#[doc(hidden)]
11091108
fn layout(&self) -> crate::Layout {
11101109
crate::Layout::one_dimensional()
11111110
}
1112-
#[doc(hidden)]
1111+
11131112
fn raw_dim(&self) -> Self::Dim {
11141113
Ix1(self.len())
11151114
}
1116-
#[doc(hidden)]
1115+
11171116
fn as_ptr(&self) -> Self::Ptr {
11181117
if self.len() > 0 {
11191118
// `self.iter.index` is guaranteed to be in-bounds if any of the
@@ -1131,28 +1130,26 @@ impl<'a, A, D: Dimension> NdProducer for AxisIter<'a, A, D> {
11311130
self.iter.stride
11321131
}
11331132

1134-
#[doc(hidden)]
11351133
unsafe fn as_ref(&self, ptr: Self::Ptr) -> Self::Item {
11361134
ArrayView::new_(
11371135
ptr,
11381136
self.iter.inner_dim.clone(),
11391137
self.iter.inner_strides.clone(),
11401138
)
11411139
}
1142-
#[doc(hidden)]
1140+
11431141
unsafe fn uget_ptr(&self, i: &Self::Dim) -> Self::Ptr {
11441142
self.iter.offset(self.iter.index + i[0])
11451143
}
11461144

1147-
#[doc(hidden)]
11481145
fn stride_of(&self, _axis: Axis) -> isize {
11491146
self.contiguous_stride()
11501147
}
11511148

1152-
#[doc(hidden)]
11531149
fn split_at(self, _axis: Axis, index: usize) -> (Self, Self) {
11541150
self.split_at(index)
11551151
}
1152+
11561153
private_impl! {}
11571154
}
11581155

@@ -1162,15 +1159,14 @@ impl<'a, A, D: Dimension> NdProducer for AxisIterMut<'a, A, D> {
11621159
type Ptr = *mut A;
11631160
type Stride = isize;
11641161

1165-
#[doc(hidden)]
11661162
fn layout(&self) -> crate::Layout {
11671163
crate::Layout::one_dimensional()
11681164
}
1169-
#[doc(hidden)]
1165+
11701166
fn raw_dim(&self) -> Self::Dim {
11711167
Ix1(self.len())
11721168
}
1173-
#[doc(hidden)]
1169+
11741170
fn as_ptr(&self) -> Self::Ptr {
11751171
if self.len() > 0 {
11761172
// `self.iter.index` is guaranteed to be in-bounds if any of the
@@ -1188,28 +1184,26 @@ impl<'a, A, D: Dimension> NdProducer for AxisIterMut<'a, A, D> {
11881184
self.iter.stride
11891185
}
11901186

1191-
#[doc(hidden)]
11921187
unsafe fn as_ref(&self, ptr: Self::Ptr) -> Self::Item {
11931188
ArrayViewMut::new_(
11941189
ptr,
11951190
self.iter.inner_dim.clone(),
11961191
self.iter.inner_strides.clone(),
11971192
)
11981193
}
1199-
#[doc(hidden)]
1194+
12001195
unsafe fn uget_ptr(&self, i: &Self::Dim) -> Self::Ptr {
12011196
self.iter.offset(self.iter.index + i[0])
12021197
}
12031198

1204-
#[doc(hidden)]
12051199
fn stride_of(&self, _axis: Axis) -> isize {
12061200
self.contiguous_stride()
12071201
}
12081202

1209-
#[doc(hidden)]
12101203
fn split_at(self, _axis: Axis, index: usize) -> (Self, Self) {
12111204
self.split_at(index)
12121205
}
1206+
12131207
private_impl! {}
12141208
}
12151209

src/private.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ macro_rules! private_decl {
1111
() => {
1212
/// This trait is private to implement; this method exists to make it
1313
/// impossible to implement outside the crate.
14+
#[doc(hidden)]
1415
fn __private__(&self) -> crate::private::PrivateMarker;
1516
}
1617
}
1718

1819
macro_rules! private_impl {
1920
() => {
20-
#[doc(hidden)]
2121
fn __private__(&self) -> crate::private::PrivateMarker {
2222
crate::private::PrivateMarker
2323
}

0 commit comments

Comments
 (0)