| Age | Commit message (Collapse) | Author | Lines |
|
|
|
Displaying `std::u32::max_value` is misleading so just display
`u32::max_value`.
|
|
|
|
They're displayed in the same order as they are on modules pages.
|
|
Realized browsers use [Ctrl]+[+=] for zoom, so using [Shift]+[+=] for
collapse/expand was not necessarily a conflict.
Also a bugfix.
|
|
Allows both `T` and `t`.
It had been [Shift]+[+] before.
|
|
Now when the user presses the "+" key all sections will collapse/expand.
Also added a note to the help screen which describes this behavior.
|
|
|
|
|
|
|
|
This allows to search for crates in documentation and simplifies the json serialization of the search-index.
fixes #14077
|
|
|
|
This enables `*` in all type positions in doc searches, which I often
want in order to find functions that create or convert specific
types (e.g. `* -> vec`) but I don't actually know what kinds of input
they expect.
I actually started working on this because of #31598, but I've wanted it
several times when exploring new crates.
|
|
|
|
Previously only keyup event was looked at, which meant that pasting, cutting and
otherwise changing the input without typing would not catch any updates to the
search query.
|
|
|
|
-Add a validation when input search is empty on top of 'startSearch()'
|
|
a validation when input search is empty on top of 'startSearch()'
|
|
|
|
history.pushState is defined, but not working whenever document.origin is "null"
(literally that string, not just the null object).
This is due to some security considerations and is unlikely to be ever working.
For now just disable the usage of the history API when the documentation
is accessed through a file:/ URL.
See https://code.google.com/p/chromium/issues/detail?id=301210 for a
Chrome-specific issue on the history API on file:/ URLs
Closes #25953
|
|
- section.sidebar -> nav.sidebar, also added an unordered list.
- div#help -> aside#help, also added a hidden heading.
- the current crate is now emphasized in the sidebar.
Fixes #16310.
|
|
|
|
Blurs the document's background when the help dialogue is present,
making the contents of the dialogue stand out more.
|
|
|
|
|
|
|
|
|
|
Fixes #26673
|
|
non-english keyboard layouts. Fixes #26016 Fixes #16572
|
|
Fixes #26360.
|
|
|
|
There are more possible optimizations left (cached length in loops) as
well as some possible bugs (shadowed variables) to fix. This is mostly
syntactic.
|
|
Rustdoc fixes for associated items
This is related to isssue #22442 and solves it partly.
This solves the search index links of associated types and constants,
so that they link to the trait page.
Also add an Associated Constants section if constants are present.
|
|
This is related to isssue #22442 and solves it partly.
This solves the links of associated types and constants, so that they
link to the trait page.
|
|
This style inconsistency was noted at https://travis-ci.org/rust-lang/rust/builds/61583070#L371
|
|
To separate concerns, instead of checking the state of `#toggle-all-docs` by looking at its label text, I add or remove a class `will-expand` depending on whether the button’s next click will expand everything. (The `if` statement’s two branches were swapped as part of this change.)
I moved the desired text values to a function `labelForToggleButton`, so changing the values will be easier. I also note in a comment the other file where the text is duplicated.
To allow the labels of both types of toggle buttons to be uniformly set, I added a `span.inner` to the global button too.
I split the template in `render.rs` into multiple lines to make room for the `span`, and that adds whitespace around the `[` and `]` text elements. That seems to be okay, though – the page still looks the same.
I updated the CSS styling for `.collapse-toggle > .inner` to add a little extra space around the symbol, to make minus signs easier to identify. (`#toggle-all-docs > .inner` does not need the same style, since its text size is bigger, so it naturally puts more space around the symbol.)
|
|
The cause of the problem is described here: https://github.com/rust-lang/rust/pull/24797#issuecomment-97049765 .
I tested this new `main.js` by changing the `main.js` content of a rendered docs page to this new content. The [−] button worked again.
|
|
So that if people accidentally delete the character, they won’t re-type it as a hyphen, which would cause bugs.
I changed ‘+’ too, even though it won’t be re-typed incorrectly, so that it is easier to see when plus is used as a symbol for the button, and when it is used as an operator in code. It also makes it clearer that the use of an entity for minus is on purpose, so people won’t be tempted to replace the entity incorrectly with a hyphen character.
|
|
The minus sign ‘−’ is the same width as the plus sign ‘+’, so the button’s transition between the two symbols will look more smooth.
|
|
r? @alexcrichton (since you added `.stability` warning messages)
|
|
|
|
|
|
The source filename for cross crate macros isn't quite right so the normal
generated links are invalid.
Closes #21311
|
|
Only '?' should do that.
Fixes #24289.
|
|
If a result is highlighted, when the search changes that state should no
longer be highlighted. Fixes #24044
cc @steveklabnik
|
|
If a result is highlighted, when the search changes that state should no
longer be highlighted. Fixes #24044
cc @steveklabnik
|
|
Validate if the description is available in the rawSearchIndex
|
|
This adds search by type (for functions/methods) support to Rustdoc. Target issue is at https://github.com/rust-lang/rfcs/issues/658.
I've described my approach here: https://github.com/rust-lang/rfcs/issues/658#issuecomment-76484200. I'll copy the text in here as well:
---
Hi, it took me longer than I wished, but I have implemented this in a not-too-complex way that I think can be extended to support more complex features (like the ones mentioned [here](https://github.com/rust-lang/rust/issues/12866#issuecomment-66945317)).
The idea is to generate a JSON representation of the types of methods/functions in the existing index, and then make the JS understand when it should look by type (and not by name).
I tried to come up with a JSON representation that can be extended to support generics, bounds, ref/mut annotations and so on. Here are a few samples:
Function:
```rust
fn to_uppercase(c: char) -> char
```
```json
{
"inputs": [
{"name": "char"}
],
"output": {
"name": "char",
}
}
```
Method (implemented or defined in trait):
```rust
// in struct Vec
// self is considered an argument as well
fn capacity(&self) -> usize
```
```json
{
"inputs": [
{"name": "vec"}
],
"output": {
"name": "usize"
}
}
```
This simple format can be extended by adding more fields, like `generic: bool`, a `bounds` mapping and so on.
I have a working implementation in https://github.com/rust-lang/rust/compare/master...mihneadb:rustdoc-search-by-type. You can check out a live demo [here](http://data.mihneadb.net/doc/std/index.html?search=charext%20-%3E%20char).

The feature list is not that long:
- search by types (you *can* use generics as well, as long as you use the exact name - e.g. [`vec,t -> `](http://data.mihneadb.net/doc/std/index.html?search=vec%2C%20t%20-%3E))
- order of arguments does not matter
- `self` is took into account as well (e.g. search for `vec -> usize`)
- does not use "complex" annotations (e.g. you don't search for `&char -> char` but for `char -> char`)
My goal is to get a working, minimal "base" merged so that others can build upon it. How should I proceed? Do I open a PR (badly in need of code review since this is my first non "hello world"-ish rust code)?
---
|
|
|
|
Fixes #22325
|