Skip to content

Improve names and types in Rust stdlib scraper #2596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
simon04 merged 1 commit into from
Oct 21, 2025
Merged

Improve names and types in Rust stdlib scraper #2596

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions lib/docs/filters/rust/entries.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,15 @@ def get_name
else
at_css('main h1').at_css('button')&.remove
name = at_css('main h1').content.remove(/\A.+\s/).remove('⎘')
mod = slug.split('/').first
path = slug.split('/')
if path.length == 2
# Anything in the standard library but not in a `std::*` module is
# globally available, not `use`d from the `std` crate, so we don't
# prepend `std::` to their name.
return name
end
path.pop if path.last == 'index'
mod = path[0..-2].join('::')
name.prepend("#{mod}::") unless name.start_with?(mod)
name
end
Expand All @@ -38,13 +46,12 @@ def get_type
elsif slug.start_with?('error_codes')
'Compiler Errors'
else
path = name.split('::')
heading = at_css('main h1').content.strip
if path.length > 2 || (path.length == 2 && (heading.start_with?('Module') || heading.start_with?('Primitive')))
path[0..1].join('::')
else
path[0]
end
path = slug.split('/')
# Discard the filename, and use the first two path components as the
# type, or one if there is only one. This means anything in a module
# `std::foo` or submodule `std::foo::bar` gets type `std::foo`, and
# things not in modules, e.g. primitive types, get type `std`.
path[0..-2][0..1].join('::')
end
end

Expand Down