mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #103799 - GuillaumeGomez:search-index-tuple-struct-field, r=notriddle

Browse Source 
Remove generation of tuple struct fields in the search index

This comes from [this discussion](https://github.com/rust-lang/rust/pull/103710) as they're not very useful.

r? `@notriddle`
This commit is contained in:
Yuki Okushi 2022-11-01 12:03:44 +09:00 committed by GitHub
commit fca9093ea3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 40 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
src/librustdoc/formats/cache.rs
View File

@ -316,21 +316,28 @@ fn fold_item(&mut self, item: clean::Item) -> Option<clean::Item> {
let desc = item.doc_value().map_or_else(String::new, |x| {
short_markdown_summary(x.as_str(), &item.link_names(self.cache))
});
self.cache.search_index.push(IndexItem {
ty: item.type_(),
name: s.to_string(),
path: join_with_double_colon(path),
desc,
parent,
parent_idx: None,
search_type: get_function_type_for_search(
&item,
self.tcx,
clean_impl_generics(self.cache.parent_stack.last()).as_ref(),
self.cache,
),
aliases: item.attrs.get_doc_aliases(),
});
let ty = item.type_();
let name = s.to_string();
if ty != ItemType::StructField || u16::from_str_radix(&name, 10).is_err() {
// In case this is a field from a tuple struct, we don't add it into
// the search index because its name is something like "0", which is
// not useful for rustdoc search.
self.cache.search_index.push(IndexItem {
ty,
name,
path: join_with_double_colon(path),
desc,
parent,
parent_idx: None,
search_type: get_function_type_for_search(
&item,
self.tcx,
clean_impl_generics(self.cache.parent_stack.last()).as_ref(),
self.cache,
),
aliases: item.attrs.get_doc_aliases(),
});
}
}
}
(Some(parent), None) if is_inherent_impl_item => {

18
src/test/rustdoc/no-unit-struct-field.rs Normal file
View File

@ -0,0 +1,18 @@
// This test ensures that the tuple struct fields are not generated in the
// search index.
// @!hasraw search-index.js '"0"'
// @!hasraw search-index.js '"1"'
// @hasraw search-index.js '"foo_a"'
// @hasraw search-index.js '"bar_a"'
pub struct Bar(pub u32, pub u8);
pub struct Foo {
pub foo_a: u8,
}
pub enum Enum {
Foo(u8),
Bar {
bar_a: u8,
},
}