You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
about: Report an issue with how docs get generated.
4
+
labels: C-bug, T-rustdoc
5
+
---
6
+
<!--
7
+
Thank you for filing a rustdoc issue! Rustdoc is the tool that handles the generation of docs. It is usually invoked via `cargo doc`, but can also be used directly.
8
+
9
+
If you have an issue with the actual content of the docs, use the "Documentation problem" template instead.
10
+
-->
11
+
12
+
# Code
13
+
<!-- problematic snippet and/or link to repo and/or full path of standard library function -->
14
+
15
+
```rust
16
+
<code>
17
+
```
18
+
19
+
# Reproduction Steps
20
+
<!--
21
+
* command(s) to run, if any
22
+
* permalink to hosted documentation, if any
23
+
* search query, if any
24
+
-->
25
+
26
+
# Expected Outcome
27
+
<!--
28
+
What did you want to happen?
29
+
30
+
For GUI issues, feel free to provide a mockup image of what you want it to look like.
31
+
32
+
For diagnostics, please provide a mockup of the desired output in a code block.
33
+
-->
34
+
35
+
# Actual Output
36
+
<!--
37
+
* rustdoc console output
38
+
* browser screenshot of generated html
39
+
* rustdoc json (prettify by running through `jq` or running thorugh an online formatter)
40
+
-->
41
+
```console
42
+
<code>
43
+
```
44
+
45
+
46
+
# Version
47
+
<!--
48
+
Available via `rustdoc --version` or under the "Help" menu.
49
+
50
+
If the issue involves opening the documentation in a browser, please also provide the name and version of the browser used.
Thank you for creating a future-incompatible tracking issue! 📜 These issues
9
+
are for lints that implement a future-incompatible warning.
10
+
11
+
Remember to add team labels to the tracking issue.
12
+
For something that affects the language, this would be `T-lang`, and for libs
13
+
it would be `T-libs-api`.
14
+
Also check for any `A-` labels to add.
15
+
-->
16
+
17
+
This is the **tracking issue** for the `YOUR_LINT_NAME_HERE` future-compatibility warning and other related errors. The goal of this page is to describe why this change was made and how you can fix code that is affected by it. It also provides a place to ask questions or register a complaint if you feel the change should not be made. For more information on the policy around future-compatibility warnings, see our [breaking change policy guidelines][guidelines].
*Describe the conditions that trigger the warning.*
24
+
25
+
### Why was this change made?
26
+
27
+
*Explain why this change was made. If there is additional context, like an MCP, link it here.*
28
+
29
+
### Example
30
+
31
+
```rust
32
+
// Include an example here.
33
+
```
34
+
35
+
### Recommendations
36
+
37
+
*Give some recommendations on how a user can avoid the lint.*
38
+
39
+
### When will this warning become a hard error?
40
+
41
+
*If known, describe the future plans. For example, how long you anticipate this being a warning, or if there are other factors that will influence the anticipated closure.*
42
+
43
+
### Steps
44
+
45
+
-[ ] Implement the lint
46
+
-[ ] Raise lint level to deny
47
+
-[ ] Change the lint to report in dependencies
48
+
-[ ] Switch to a hard error
49
+
50
+
### Implementation history
51
+
52
+
<!--
53
+
Include a list of all the PRs that were involved in implementing the lint.
0 commit comments