Skip to content

Commit 584d297

Browse files
committed
rewrite bullet points as prose
1 parent 3684bee commit 584d297

File tree

5 files changed

+266
-210
lines changed

5 files changed

+266
-210
lines changed

src/items/use-declarations.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ They may create bindings for:
116116
* [Built-in types]
117117
* [Attributes]
118118
* [Derive macros]
119-
* [Macros by example]
119+
* [`macro_rules`]
120120

121121
r[items.use.path.disallowed]
122122
They cannot import [associated items], [generic parameters], [local variables], paths with [`Self`], or [tool attributes]. More restrictions are described below.
@@ -303,6 +303,10 @@ mod clashing {
303303
}
304304
```
305305

306+
> [!NOTE]
307+
>
308+
> For areas where shadowing is not allowed, see [name resolution ambiguities].
309+
306310
r[items.use.glob.last-segment-only]
307311
`*` cannot be used as the first or intermediate segments.
308312

@@ -390,10 +394,6 @@ r[items.use.restrictions.variant]
390394
use TypeAlias::MyVariant; //~ ERROR
391395
```
392396

393-
TODO mention ambiguities and link to name-res. Moved to name-res because
394-
ambiguities are fundamentally a product of the place of use, not the use
395-
declaration.
396-
397397
[`extern crate`]: extern-crates.md
398398
[`macro_rules`]: ../macros-by-example.md
399399
[`self`]: ../paths.md#self
@@ -412,3 +412,4 @@ declaration.
412412
[tool attributes]: ../attributes.md#tool-attributes
413413
[type alias]: type-aliases.md
414414
[type namespace]: ../names/namespaces.md
415+
[name resolution ambiguities]: ../names/name-resolution.html#r-names.resolution.expansion.imports.errors.ambiguity

src/macros-by-example.md

Lines changed: 37 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -326,8 +326,9 @@ fn foo() {
326326
// m!(); // Error: m is not in scope.
327327
```
328328

329-
* textual scope name bindings for macros may shadow path-based scope bindings
330-
to macros
329+
r[macro.decl.scope.textual.shadow.path-based]
330+
Textual scope name bindings for macros may shadow path-based scope bindings to
331+
macros.
331332

332333
```rust
333334
macro_rules! m {
@@ -348,6 +349,38 @@ use crate::m2 as m;
348349
m!(); // prints "m\n"
349350
```
350351

352+
> [!NOTE]
353+
>
354+
> For areas where shadowing is not allowed, see [name resolution ambiguities].
355+
356+
r[macro.decl.scope.path-based]
357+
### Path-based scope
358+
359+
r[macro.decl.scope.path-based.intro]
360+
By default, a macro has no path-based scope. Macros can gain path-based scope in two ways:
361+
362+
* [Use declaration re-export]
363+
* [`#[macro_export]`](macros-by-example.html#the-macro_export-attribute)
364+
365+
r[macro.decl.scope.path.reexport]
366+
Macros can be re-exported to give them path-based scope from a module other than the crate root.
367+
368+
```rust
369+
mac::m!(); // OK: Path-based lookup finds m in the mac module.
370+
371+
mod mac {
372+
macro_rules! m {
373+
() => {};
374+
}
375+
pub(crate) use m;
376+
}
377+
```
378+
379+
r[macro.decl.scope.path-based.visibility]
380+
* macros have an implicit visibility of `pub(crate)`
381+
* `#[macro_export]` changes the implicit visibility to `pub`
382+
* macro definitions do not support direct visibility modifiers
383+
351384
<!-- template:attributes -->
352385
r[macro.decl.scope.macro_use]
353386
### The `macro_use` attribute
@@ -502,25 +535,6 @@ By default, macros only have [textual scope][macro.decl.scope.textual] and canno
502535
> # fn main() {}
503536
> ```
504537
505-
r[macro.decl.scope.path.reexport]
506-
507-
* macros can be re-exported to give them path-based scope from a module other than the crate root.
508-
* there's some visibility stuff here that may already be mentioned
509-
elsewhere. I'm pretty sure that w/o a #[macro_export] the macro being
510-
re-exported is implicitly pub(crate) and with one it is implicitly pub.
511-
The later is mentioned below, don't remember where I saw the former.
512-
513-
```
514-
mac::m!(); // OK: Path-based lookup finds m in the mac module.
515-
516-
mod mac {
517-
macro_rules! m {
518-
() => {};
519-
}
520-
pub(crate) use m;
521-
}
522-
```
523-
524538
r[macro.decl.scope.macro_export.export]
525539
The `macro_export` attribute causes a macro to be exported from the crate root so that it can be referred to in other crates by path.
526540
@@ -765,3 +779,5 @@ For more detail, see the [formal specification].
765779
[Repetitions]: #repetitions
766780
[token]: tokens.md
767781
[`$crate`]: macro.decl.hygiene.crate
782+
[Use declaration re-export]: items/use-declarations.html#use-visibility
783+
[name resolution ambiguities]: ../names/name-resolution.html#r-names.resolution.expansion.imports.errors.ambiguity

src/macros.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,15 @@ macro_rules! example {
106106
example!();
107107
```
108108

109+
r[macro.invocation.name-resolution]
110+
111+
* Macros invocations can be resolved via two kinds of scopes
112+
* Path-based scope
113+
* All procedural macros, attributes
114+
* macro by example
115+
* Textual Scope
116+
* macro by example
117+
109118
[Macros by Example]: macros-by-example.md
110119
[Procedural Macros]: procedural-macros.md
111120
[associated items]: items/associated-items.md

0 commit comments

Comments
 (0)