Skip to content

Commit b443c9b

Browse files
committed
some text improvements
1 parent 59fc8f9 commit b443c9b

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/rustdoc.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,24 +102,23 @@ See [Rustdoc tests suites](tests/compiletest.md#rustdoc-test-suites) for more de
102102
## Constraints
103103

104104
We try to make rustdoc work reasonably well with JavaScript disabled, and when browsing local files.
105-
We support
106-
[these browsers](https://rust-lang.github.io/rfcs/1985-tiered-browser-support.html#supported-browsers).
105+
We have [a list of supported browsers].
107106

108107
Supporting local files (`file:///` URLs) brings some surprising restrictions.
109108
Certain browser features that require secure origins, like `localStorage` and
110109
Service Workers, don't work reliably.
111-
We can still use such features but we should make sure pages are still usable without them.
110+
We can still use such features, but we should make sure pages are still usable without them.
112111

113112
Rustdoc [does not type-check function bodies][platform-specific docs].
114113
This works by [overriding the built-in queries for typeck][override queries],
115114
by [silencing name resolution errors], and by [not resolving opaque types].
116115
This comes with several caveats: in particular, rustdoc *cannot* run any parts of the compiler that
117116
require type-checking bodies;
118-
for example it cannot generate `.rlib` files or run most lints.
117+
for example, it cannot generate `.rlib` files or run most lints.
119118
We want to move away from this model eventually, but we need some alternative for
120119
[the people using it][async-std];
121120
see [various][zulip stop accepting broken code]
122-
[previous][rustdoc meeting 2024-07-08] [Zulip][compiler meeting 2023-01-26] [discussion][notriddle rfc].
121+
[previous][rustdoc meeting 2024-07-08] [Zulip][compiler meeting 2023-01-26] [discussions][notriddle rfc].
123122
For examples of code that breaks if this hack is removed, see
124123
[`tests/rustdoc-ui/error-in-impl-trait`].
125124

@@ -133,6 +132,7 @@ For examples of code that breaks if this hack is removed, see
133132
[zulip stop accepting broken code]: https://rust-lang.zulipchat.com/#narrow/stream/266220-rustdoc/topic/stop.20accepting.20broken.20code
134133
[notriddle rfc]: https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc/topic/Pre-RFC.3A.20stop.20accepting.20broken.20code
135134
[`tests/rustdoc-ui/error-in-impl-trait`]: https://github.com/rust-lang/rust/tree/163cb4ea3f0ae3bc7921cc259a08a7bf92e73ee6/tests/rustdoc-ui/error-in-impl-trait
135+
[a list of supported browsers]: https://rust-lang.github.io/rfcs/1985-tiered-browser-support.html#supported-browsers
136136

137137
## Multiple runs, same output directory
138138

@@ -200,7 +200,7 @@ use.
200200
In both cases, people may use `--document-private-items` Cargo flag to
201201
see private methods, fields, and so on, which are normally not displayed.
202202

203-
By default `cargo doc` will generate documentation for a crate and all of its dependencies.
203+
By default, `cargo doc` will generate documentation for a crate and all of its dependencies.
204204
That can result in a very large documentation bundle, with a large (and slow) search corpus.
205205
The Cargo flag `--no-deps` inhibits that behavior and generates docs for just the crate.
206206

0 commit comments

Comments
 (0)