Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ we welcome PRs to fix them. Additionally, larger editing jobs that help remove
the number of parentheticals, remove comma splices, italicize term definitions
and other similar tasks are helpful.

## Adding Examples and Glossary Entries
## Adding examples and glossary entries

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

## Adding Documentation
## Adding documentation

There are a lot of features that are not documented at all or are documented
poorly. This is the hardest, but definitely most valuable. Pick an unassigned
Expand Down
4 changes: 2 additions & 2 deletions docs/review-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Team members are given permission to merge changes from other contributors in th
- 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.
- 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.

## Review Process Flowchart
## Review process flowchart

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

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

[authoring guide]: authoring.md
[authoring guide]: authoring.md
18 changes: 9 additions & 9 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
- [Tokens](tokens.md)

- [Macros](macros.md)
- [Macros By Example](macros-by-example.md)
- [Procedural Macros](procedural-macros.md)
- [Macros by example](macros-by-example.md)
- [Procedural macros](procedural-macros.md)

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

Expand All @@ -35,15 +35,15 @@
- [Implementations](items/implementations.md)
- [External blocks](items/external-blocks.md)
- [Generic parameters](items/generics.md)
- [Associated Items](items/associated-items.md)
- [Associated items](items/associated-items.md)

- [Attributes](attributes.md)
- [Testing](attributes/testing.md)
- [Derive](attributes/derive.md)
- [Diagnostics](attributes/diagnostics.md)
- [Code generation](attributes/codegen.md)
- [Limits](attributes/limits.md)
- [Type System](attributes/type_system.md)
- [Type system](attributes/type_system.md)
- [Debugger](attributes/debugger.md)

- [Statements and expressions](statements-and-expressions.md)
Expand Down Expand Up @@ -91,10 +91,10 @@
- [Impl trait type](types/impl-trait.md)
- [Type parameters](types/parameters.md)
- [Inferred type](types/inferred.md)
- [Dynamically Sized Types](dynamically-sized-types.md)
- [Dynamically sized types](dynamically-sized-types.md)
- [Type layout](type-layout.md)
- [Interior mutability](interior-mutability.md)
- [Subtyping and Variance](subtyping.md)
- [Subtyping and variance](subtyping.md)
- [Trait and lifetime bounds](trait-bounds.md)
- [Type coercions](type-coercions.md)
- [Destructors](destructors.md)
Expand Down Expand Up @@ -125,15 +125,15 @@
- [Behavior considered undefined](behavior-considered-undefined.md)
- [Behavior not considered unsafe](behavior-not-considered-unsafe.md)

- [Constant Evaluation](const_eval.md)
- [Constant evaluation](const_eval.md)

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

- [The Rust runtime](runtime.md)

- [Appendices](appendices.md)
- [Grammar summary](grammar.md)
- [Macro Follow-Set Ambiguity Formal Specification](macro-ambiguity.md)
- [Macro follow-set ambiguity formal specification](macro-ambiguity.md)
- [Influences](influences.md)
- [Test summary](test-summary.md)
- [Glossary](glossary.md)
2 changes: 1 addition & 1 deletion src/abi.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
r[abi]
# Application Binary Interface (ABI)
# Application binary interface (ABI)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

paused seeing this one, then "nah, it good" (then I checked how wikipedia does it, and it matches your change)


r[abi.intro]
This section documents features that affect the ABI of the compiled output of
Expand Down
2 changes: 1 addition & 1 deletion src/attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ fn some_unused_variables() {
```

r[attributes.meta]
## Meta Item Attribute Syntax
## Meta item attribute syntax

r[attributes.meta.intro]
A "meta item" is the syntax used for the [Attr] rule by most [built-in
Expand Down
2 changes: 1 addition & 1 deletion src/attributes/diagnostics.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ pub mod m3 {
> `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.

r[attributes.diagnostics.lint.reason]
### Lint Reasons
### Lint reasons

All lint attributes support an additional `reason` parameter, to give context why
a certain attribute was added. This reason will be displayed as part of the lint
Expand Down
2 changes: 1 addition & 1 deletion src/conditional-compilation.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ r[cfg.option-key-uniqueness]
Keys do not need to be unique. For example, both `feature = "std"` and `feature = "serde"` can be set at the same time.

r[cfg.options.set]
## Set Configuration Options
## Set configuration options

r[cfg.options.general]
Which configuration options are set is determined statically during the
Expand Down
2 changes: 1 addition & 1 deletion src/const_eval.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ const generic parameter, or an arbitrary expression not making use of any
generics.

r[const-eval.const-fn]
## Const Functions
## Const functions

r[const-eval.const-fn.general]
A _const fn_ is a function that one is permitted to call from a const context.
Expand Down
2 changes: 1 addition & 1 deletion src/crates-and-source-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ apply to the crate as a whole.
```

r[crate.main]
## Main Functions
## Main functions

r[crate.main.general]
A crate that contains a `main` [function] can be compiled to an executable.
Expand Down
2 changes: 1 addition & 1 deletion src/dynamically-sized-types.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
r[dynamic-sized]
# Dynamically Sized Types
# Dynamically sized types

r[dynamic-sized.intro]
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>.
Expand Down
8 changes: 4 additions & 4 deletions src/expressions.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ assert_eq!(
> Since this is applied recursively, these expressions are also evaluated from innermost to outermost, ignoring siblings until there are no inner subexpressions.

r[expr.place-value]
## Place Expressions and Value Expressions
## Place expressions and value expressions

r[expr.place-value.intro]
Expressions are divided into two main categories: place expressions and value expressions;
Expand Down Expand Up @@ -256,7 +256,7 @@ The expression evaluates to that location instead, except if [promoted] to a `st
The [drop scope] of the temporary is usually the end of the enclosing statement.

r[expr.implicit-borrow]
### Implicit Borrows
### Implicit borrows

r[expr.implicit-borrow-intro]
Certain expressions will treat an expression as a place expression by implicitly borrowing it.
Expand Down Expand Up @@ -287,13 +287,13 @@ Implicit borrows may be taken in the following expressions:
* Left operands of the [compound assignment].

r[expr.overload]
## Overloading Traits
## Overloading traits

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

r[expr.attr]
## Expression Attributes
## Expression attributes

r[expr.attr.restriction]
[Outer attributes] before an expression are allowed only in a few specific cases:
Expand Down
2 changes: 1 addition & 1 deletion src/expressions/call-expr.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ let name: &'static str = (|| "Rust")();
```

r[expr.call.desugar]
## Disambiguating Function Calls
## Disambiguating function calls

r[expr.call.desugar.fully-qualified]
All function calls are sugar for a more explicit [fully-qualified syntax].
Expand Down
4 changes: 2 additions & 2 deletions src/expressions/operator-expr.md
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ assert_eq!(true, !false);
```

r[expr.arith-logic]
## Arithmetic and Logical Binary Operators
## Arithmetic and logical binary operators

r[expr.arith-logic.syntax]
```grammar,expressions
Expand Down Expand Up @@ -408,7 +408,7 @@ assert_eq!(-10 >> 2, -3);
```

r[expr.cmp]
## Comparison Operators
## Comparison operators

r[expr.cmp.syntax]
```grammar,expressions
Expand Down
10 changes: 5 additions & 5 deletions src/inline-assembly.md
Original file line number Diff line number Diff line change
Expand Up @@ -1522,7 +1522,7 @@ extern "sysv64-unwind" fn may_panic() {
> - [ImperialViolet - CFI directives in assembly files](https://www.imperialviolet.org/2017/01/18/cfi.html)

r[asm.validity]
### Correctness and Validity
### Correctness and validity

r[asm.validity.necessary-but-not-sufficient]
In addition to all of the previous rules, the string argument to `asm!` must ultimately become---
Expand All @@ -1548,7 +1548,7 @@ Programmers should exercise appropriate care, as invoking this `unsafe` capabili
assuming the responsibility of not violating rules of both the compiler or the architecture.

r[asm.directives]
### Directives Support
### Directives support

r[asm.directives.subset-supported]
Inline assembly supports a subset of the directives supported by both GNU AS and LLVM's internal assembler, given as follows.
Expand Down Expand Up @@ -1630,10 +1630,10 @@ assert_eq!(s, "Hello World!");
```

r[asm.target-specific-directives]
#### Target Specific Directive Support
#### Target specific directive support

r[asm.target-specific-directives.dwarf-unwinding]
##### Dwarf Unwinding
##### Dwarf unwinding

The following directives are supported on ELF targets that support DWARF unwind info:

Expand All @@ -1660,7 +1660,7 @@ The following directives are supported on ELF targets that support DWARF unwind
- `.cfi_window_save`

r[asm.target-specific-directives.structured-exception-handling]
##### Structured Exception Handling
##### Structured exception handling

On targets with structured exception Handling, the following additional directives are guaranteed to be supported:

Expand Down
2 changes: 1 addition & 1 deletion src/interior-mutability.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
r[interior-mut]
# Interior Mutability
# Interior mutability

r[interior-mut.intro]
Sometimes a type needs to be mutated while having multiple aliases. In Rust this
Expand Down
10 changes: 5 additions & 5 deletions src/items/associated-items.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
r[items.associated]
# Associated Items
# Associated items

r[items.associated.syntax]
```grammar,items
Expand Down Expand Up @@ -223,7 +223,7 @@ Attributes on method parameters follow the same rules and restrictions as
[regular function parameters].

r[items.associated.type]
## Associated Types
## Associated types

r[items.associated.type.intro]
*Associated types* are [type aliases] associated with another type.
Expand Down Expand Up @@ -347,7 +347,7 @@ fn main() {
}
```

### Associated Types Container Example
### Associated types container example

Consider the following example of a `Container` trait. Notice that the type is
available for use in the method signatures:
Expand Down Expand Up @@ -461,7 +461,7 @@ trait StaticReturn {
```

r[items.associated.const]
## Associated Constants
## Associated constants

r[items.associated.const.intro]
*Associated constants* are [constants] associated with a type.
Expand Down Expand Up @@ -512,7 +512,7 @@ fn main() {
}
```

### Associated Constants Examples
### Associated constants examples

A basic example:

Expand Down
2 changes: 1 addition & 1 deletion src/items/constant-items.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ r[items.const.expr-omission]
The constant expression may only be omitted in a [trait definition].

r[items.const.destructor]
## Constants with Destructors
## Constants with destructors

Constants can contain destructors. Destructors are run when the value goes out
of scope.
Expand Down
2 changes: 1 addition & 1 deletion src/items/extern-crates.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ extern crate hello_world; // hyphen replaced with an underscore
```

r[items.extern-crate.underscore]
## Underscore Imports
## Underscore imports

r[items.extern-crate.underscore.intro]
An external crate dependency can be declared without binding its name in scope
Expand Down
10 changes: 5 additions & 5 deletions src/items/implementations.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ There are two types of implementations:
- [trait] implementations

r[items.impl.inherent]
## Inherent Implementations
## Inherent implementations

r[items.impl.inherent.intro]
An inherent implementation is defined as the sequence of the `impl` keyword,
Expand Down Expand Up @@ -98,7 +98,7 @@ fn main() {
```

r[items.impl.trait]
## Trait Implementations
## Trait implementations

r[items.impl.trait.intro]
A _trait implementation_ is defined like an inherent implementation except that
Expand Down Expand Up @@ -158,7 +158,7 @@ impl Shape for Circle {
```

r[items.impl.trait.coherence]
### Trait Implementation Coherence
### Trait implementation coherence

r[items.impl.trait.coherence.intro]
A trait implementation is considered incoherent if either the orphan rules check fails
Expand Down Expand Up @@ -200,7 +200,7 @@ special. The `T` in `Box<T>` is not considered covered, and `Box<LocalType>`
is considered local.

r[items.impl.generics]
## Generic Implementations
## Generic implementations

r[items.impl.generics.intro]
An implementation can take [generic parameters], which can be used in the rest
Expand Down Expand Up @@ -299,7 +299,7 @@ impl<'a> HasAssocType for Struct {
```

r[items.impl.attributes]
## Attributes on Implementations
## Attributes on implementations

Implementations may contain outer [attributes] before the `impl` keyword and
inner [attributes] inside the brackets that contain the associated items. Inner
Expand Down
4 changes: 2 additions & 2 deletions src/items/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ the syntax and make use of the `unsafe` keyword, before removing it from the
token stream.

r[items.mod.outlined]
## Module Source Filenames
## Module source filenames

r[items.mod.outlined.intro]
A module without a body is loaded from an external file. When the module does
Expand Down Expand Up @@ -147,7 +147,7 @@ mod thread {
```

r[items.mod.attributes]
## Attributes on Modules
## Attributes on modules

r[items.mod.attributes.intro]
Modules, like all items, accept outer attributes. They also accept inner
Expand Down
2 changes: 1 addition & 1 deletion src/items/static-items.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ Mutable statics have the same restrictions as normal statics, except that the
type does not have to implement the `Sync` trait.

r[items.static.alternate]
## Using Statics or Consts
## Using statics or consts

It can be confusing whether or not you should use a constant item or a static
item. Constants should, in general, be preferred over statics unless one of the
Expand Down
Loading