mirror of
https://github.com/rust-lang/rust.git
synced 2024-12-04 04:39:16 +00:00
7c3f0d6f30
rustdoc: compute maximum Levenshtein distance based on the query Preview: https://notriddle.com/notriddle-rustdoc-demos/search-lev-distance-2023/std/index.html?search=regex The heuristic is pretty close to the name resolver, maxLevDistance = `Math.floor(queryLen / 3)`. Fixes #103357 Fixes #82131 Similar to https://github.com/rust-lang/rust/pull/103710, but following the suggestion in https://github.com/rust-lang/rust/pull/103710#issuecomment-1296360267 to use `floor` instead of `ceil`, and unblocked now that https://github.com/rust-lang/rust/pull/105796 made it so that setting the max lev distance to `0` doesn't cause substring matches to be removed. |
||
---|---|---|
.. | ||
src | ||
anchor-navigable.goml | ||
anchors.goml | ||
auto-hide-trait-implementations.goml | ||
basic-code.goml | ||
check_info_sign_position.goml | ||
check-code-blocks-margin.goml | ||
check-stab-in-docblock.goml | ||
code-blocks-overflow.goml | ||
code-color.goml | ||
code-sidebar-toggle.goml | ||
code-tags.goml | ||
codeblock-sub.goml | ||
codeblock-tooltip.goml | ||
cursor.goml | ||
default-settings.goml | ||
docblock-big-code-mobile.goml | ||
docblock-code-block-line-number.goml | ||
docblock-details.goml | ||
docblock-table-overflow.goml | ||
docblock-table.goml | ||
duplicate-macro-reexport.goml | ||
enum-variants.goml | ||
escape-key.goml | ||
font-weight.goml | ||
hash-item-expansion.goml | ||
headers-color.goml | ||
headings.goml | ||
help-page.goml | ||
highlight-colors.goml | ||
huge-collection-of-constants.goml | ||
huge-logo.goml | ||
impl-default-expansion.goml | ||
impl-doc.goml | ||
implementors.goml | ||
item-decl-colors.goml | ||
item-info-alignment.goml | ||
item-info-overflow.goml | ||
item-info.goml | ||
item-summary-table.goml | ||
javascript-disabled.goml | ||
jump-to-def-background.goml | ||
label-next-to-symbol.goml | ||
links-color.goml | ||
list_code_block.goml | ||
method-margins.goml | ||
mobile.goml | ||
module-items-font.goml | ||
no-docblock.goml | ||
notable-trait.goml | ||
overflow-tooltip-information.goml | ||
pocket-menu.goml | ||
README.md | ||
run-on-hover.goml | ||
rust-logo.goml | ||
scrape-examples-button-focus.goml | ||
scrape-examples-color.goml | ||
scrape-examples-fonts.goml | ||
scrape-examples-layout.goml | ||
scrape-examples-toggle.goml | ||
search-filter.goml | ||
search-form-elements.goml | ||
search-input-mobile.goml | ||
search-keyboard.goml | ||
search-no-result.goml | ||
search-reexport.goml | ||
search-result-color.goml | ||
search-result-description.goml | ||
search-result-display.goml | ||
search-result-go-to-first.goml | ||
search-result-keyword.goml | ||
search-tab-change-title-fn-sig.goml | ||
search-tab.goml | ||
settings.goml | ||
shortcuts.goml | ||
sidebar-links-color.goml | ||
sidebar-macro-reexport.goml | ||
sidebar-mobile-scroll.goml | ||
sidebar-mobile.goml | ||
sidebar-source-code-display.goml | ||
sidebar-source-code.goml | ||
sidebar.goml | ||
source-anchor-scroll.goml | ||
source-code-page.goml | ||
src-font-size.goml | ||
stab-badge.goml | ||
struct-fields.goml | ||
target.goml | ||
theme-change.goml | ||
theme-in-history.goml | ||
toggle-click-deadspace.goml | ||
toggle-docs-mobile.goml | ||
toggle-docs.goml | ||
toggle-implementors.goml | ||
toggled-open-implementations.goml | ||
trait-sidebar-item-order.goml | ||
type-declation-overflow.goml | ||
unsafe-fn.goml | ||
where-whitespace.goml |
The tests present here are used to test the generated HTML from rustdoc. The goal is to prevent unsound/unexpected GUI changes.
This is using the browser-ui-test framework to do so. It works as follows:
It wraps puppeteer to send commands to a web browser in order to navigate and test what's being currently displayed in the web page.
You can find more information and its documentation in its repository.
If you need to have more information on the tests run, you can use --test-args
:
$ ./x.py test tests/rustdoc-gui --stage 1 --test-args --debug
If you don't want to run in headless mode (helpful to debug sometimes), you can use
--no-headless
:
$ ./x.py test tests/rustdoc-gui --stage 1 --test-args --no-headless
To see the supported options, use --help
.
Important to be noted: if the chromium instance crashes when you run it, you might need to
use --no-sandbox
to make it work:
$ ./x.py test tests/rustdoc-gui --stage 1 --test-args --no-sandbox