Skip to content

Commit 98cce88

Browse files
ehusstraviscross
authored andcommitted
Consistently use sentence case
Part of our style guide is to use sentence case for headings. The Reference was very inconsistent with this. This updates all the headings to use sentence case.
1 parent 02bf556 commit 98cce88

35 files changed

+83
-83
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ we welcome PRs to fix them. Additionally, larger editing jobs that help remove
3232
the number of parentheticals, remove comma splices, italicize term definitions
3333
and other similar tasks are helpful.
3434

35-
## Adding Examples and Glossary Entries
35+
## Adding examples and glossary entries
3636

3737
Examples are great. Many people will only read examples and ignore the prose.
3838
Ideally, every facet of every feature will have an example.
@@ -41,7 +41,7 @@ Likewise, the reference has a glossary. It doesn't need to explain every facet
4141
of every feature nor contain every definition, but it does need to be expanded
4242
upon. Ideally entries in the glossary link to the associated documentation.
4343

44-
## Adding Documentation
44+
## Adding documentation
4545

4646
There are a lot of features that are not documented at all or are documented
4747
poorly. This is the hardest, but definitely most valuable. Pick an unassigned

docs/review-policy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Team members are given permission to merge changes from other contributors in th
1717
- Minor changes to the tooling may be made with a review from a team member. This includes bug fixes, minor additions that are unlikely to have objections, and additions that have already been discussed.
1818
- Major changes, such as a change in how content is authored, or major changes to how the tooling works should be approved by the team without blocking objections.
1919

20-
## Review Process Flowchart
20+
## Review process flowchart
2121

2222
When reviewing a pull request, ask yourself the following questions:
2323

@@ -44,4 +44,4 @@ Some PRs are right but are awkwardly worded or have typographical problems. If t
4444
<!-- TODO -->
4545
This policy does not yet cover the process for getting final approval from the relevant teams.
4646

47-
[authoring guide]: authoring.md
47+
[authoring guide]: authoring.md

src/SUMMARY.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
- [Tokens](tokens.md)
1414

1515
- [Macros](macros.md)
16-
- [Macros By Example](macros-by-example.md)
17-
- [Procedural Macros](procedural-macros.md)
16+
- [Macros by example](macros-by-example.md)
17+
- [Procedural macros](procedural-macros.md)
1818

1919
- [Crates and source files](crates-and-source-files.md)
2020

@@ -35,15 +35,15 @@
3535
- [Implementations](items/implementations.md)
3636
- [External blocks](items/external-blocks.md)
3737
- [Generic parameters](items/generics.md)
38-
- [Associated Items](items/associated-items.md)
38+
- [Associated items](items/associated-items.md)
3939

4040
- [Attributes](attributes.md)
4141
- [Testing](attributes/testing.md)
4242
- [Derive](attributes/derive.md)
4343
- [Diagnostics](attributes/diagnostics.md)
4444
- [Code generation](attributes/codegen.md)
4545
- [Limits](attributes/limits.md)
46-
- [Type System](attributes/type_system.md)
46+
- [Type system](attributes/type_system.md)
4747
- [Debugger](attributes/debugger.md)
4848

4949
- [Statements and expressions](statements-and-expressions.md)
@@ -91,10 +91,10 @@
9191
- [Impl trait type](types/impl-trait.md)
9292
- [Type parameters](types/parameters.md)
9393
- [Inferred type](types/inferred.md)
94-
- [Dynamically Sized Types](dynamically-sized-types.md)
94+
- [Dynamically sized types](dynamically-sized-types.md)
9595
- [Type layout](type-layout.md)
9696
- [Interior mutability](interior-mutability.md)
97-
- [Subtyping and Variance](subtyping.md)
97+
- [Subtyping and variance](subtyping.md)
9898
- [Trait and lifetime bounds](trait-bounds.md)
9999
- [Type coercions](type-coercions.md)
100100
- [Destructors](destructors.md)
@@ -125,15 +125,15 @@
125125
- [Behavior considered undefined](behavior-considered-undefined.md)
126126
- [Behavior not considered unsafe](behavior-not-considered-unsafe.md)
127127

128-
- [Constant Evaluation](const_eval.md)
128+
- [Constant evaluation](const_eval.md)
129129

130-
- [Application Binary Interface](abi.md)
130+
- [Application binary interface](abi.md)
131131

132132
- [The Rust runtime](runtime.md)
133133

134134
- [Appendices](appendices.md)
135135
- [Grammar summary](grammar.md)
136-
- [Macro Follow-Set Ambiguity Formal Specification](macro-ambiguity.md)
136+
- [Macro follow-set ambiguity formal specification](macro-ambiguity.md)
137137
- [Influences](influences.md)
138138
- [Test summary](test-summary.md)
139139
- [Glossary](glossary.md)

src/abi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r[abi]
2-
# Application Binary Interface (ABI)
2+
# Application binary interface (ABI)
33

44
r[abi.intro]
55
This section documents features that affect the ABI of the compiled output of

src/attributes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ fn some_unused_variables() {
107107
```
108108

109109
r[attributes.meta]
110-
## Meta Item Attribute Syntax
110+
## Meta item attribute syntax
111111

112112
r[attributes.meta.intro]
113113
A "meta item" is the syntax used for the [Attr] rule by most [built-in

src/attributes/diagnostics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ pub mod m3 {
102102
> `rustc` allows setting lint levels on the [command-line][rustc-lint-cli], and also supports [setting caps][rustc-lint-caps] on the lints that are reported.
103103
104104
r[attributes.diagnostics.lint.reason]
105-
### Lint Reasons
105+
### Lint reasons
106106

107107
All lint attributes support an additional `reason` parameter, to give context why
108108
a certain attribute was added. This reason will be displayed as part of the lint

src/conditional-compilation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ r[cfg.option-key-uniqueness]
7171
Keys do not need to be unique. For example, both `feature = "std"` and `feature = "serde"` can be set at the same time.
7272

7373
r[cfg.options.set]
74-
## Set Configuration Options
74+
## Set configuration options
7575

7676
r[cfg.options.general]
7777
Which configuration options are set is determined statically during the

src/crates-and-source-files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ apply to the crate as a whole.
7575
```
7676

7777
r[crate.main]
78-
## Main Functions
78+
## Main functions
7979

8080
r[crate.main.general]
8181
A crate that contains a `main` [function] can be compiled to an executable.

src/dynamically-sized-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r[dynamic-sized]
2-
# Dynamically Sized Types
2+
# Dynamically sized types
33

44
r[dynamic-sized.intro]
55
Most types have a fixed size that is known at compile time and implement the trait [`Sized`][sized]. A type with a size that is known only at run-time is called a _dynamically sized type_ (_DST_) or, informally, an unsized type. [Slices], [trait objects], and [str] are examples of <abbr title="dynamically sized types">DSTs</abbr>.

src/expressions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ assert_eq!(
147147
> Since this is applied recursively, these expressions are also evaluated from innermost to outermost, ignoring siblings until there are no inner subexpressions.
148148
149149
r[expr.place-value]
150-
## Place Expressions and Value Expressions
150+
## Place expressions and value expressions
151151

152152
r[expr.place-value.intro]
153153
Expressions are divided into two main categories: place expressions and value expressions;
@@ -334,7 +334,7 @@ x; // OK
334334
```
335335

336336
r[expr.implicit-borrow]
337-
### Implicit Borrows
337+
### Implicit borrows
338338

339339
r[expr.implicit-borrow-intro]
340340
Certain expressions will treat an expression as a place expression by implicitly borrowing it.
@@ -366,13 +366,13 @@ Implicit borrows may be taken in the following expressions:
366366
* Arguments to [`format_args!`] except the format string.
367367

368368
r[expr.overload]
369-
## Overloading Traits
369+
## Overloading traits
370370

371371
Many of the following operators and expressions can also be overloaded for other types using traits in `std::ops` or `std::cmp`.
372372
These traits also exist in `core::ops` and `core::cmp` with the same names.
373373

374374
r[expr.attr]
375-
## Expression Attributes
375+
## Expression attributes
376376

377377
r[expr.attr.restriction]
378378
[Outer attributes] before an expression are allowed only in a few specific cases:

0 commit comments

Comments
 (0)