Reexport -> re-export in prose and documentation comments
This commit is contained in:
parent
90fcd4476c
commit
e168aa385b
14
RELEASES.md
14
RELEASES.md
@ -577,7 +577,7 @@ Compatibility Notes
|
||||
a warning.
|
||||
- [From the pound escape, lines consisting of multiple `#`s are
|
||||
now visible][41785]
|
||||
- [It is an error to reexport private enum variants][42460]. This is
|
||||
- [It is an error to re-export private enum variants][42460]. This is
|
||||
known to break a number of crates that depend on an older version of
|
||||
mustache.
|
||||
- [On Windows, if `VCINSTALLDIR` is set incorrectly, `rustc` will try
|
||||
@ -2251,10 +2251,10 @@ Rustdoc
|
||||
-------
|
||||
|
||||
* [Fix empty implementation section on some module pages](https://github.com/rust-lang/rust/pull/34536)
|
||||
* [Fix inlined renamed reexports in import lists](https://github.com/rust-lang/rust/pull/34479)
|
||||
* [Fix inlined renamed re-exports in import lists](https://github.com/rust-lang/rust/pull/34479)
|
||||
* [Fix search result layout for enum variants and struct fields](https://github.com/rust-lang/rust/pull/34477)
|
||||
* [Fix issues with source links to external crates](https://github.com/rust-lang/rust/pull/34387)
|
||||
* [Fix redirect pages for renamed reexports](https://github.com/rust-lang/rust/pull/34245)
|
||||
* [Fix redirect pages for renamed re-exports](https://github.com/rust-lang/rust/pull/34245)
|
||||
|
||||
Tooling
|
||||
-------
|
||||
@ -4988,7 +4988,7 @@ Version 0.10 (2014-04-03)
|
||||
* std: The `vec` module has been renamed to `slice`.
|
||||
* std: A new vector type, `Vec<T>`, has been added in preparation for DST.
|
||||
This will become the only growable vector in the future.
|
||||
* std: `std::io` now has more public-reexports. Types such as `BufferedReader`
|
||||
* std: `std::io` now has more public re-exports. Types such as `BufferedReader`
|
||||
are now found at `std::io::BufferedReader` instead of
|
||||
`std::io::buffered::BufferedReader`.
|
||||
* std: `print` and `println` are no longer in the prelude, the `print!` and
|
||||
@ -5079,8 +5079,8 @@ Version 0.10 (2014-04-03)
|
||||
* render standalone markdown files.
|
||||
* the --test flag tests all code blocks by default.
|
||||
* exported macros are displayed.
|
||||
* reexported types have their documentation inlined at the location of the
|
||||
first reexport.
|
||||
* re-exported types have their documentation inlined at the location of the
|
||||
first re-export.
|
||||
* search works across crates that have been rendered to the same output
|
||||
directory.
|
||||
|
||||
@ -5467,7 +5467,7 @@ Version 0.7 (2013-07-03)
|
||||
incl. `any`, `all`. removed.
|
||||
* std: The `finalize` method of `Drop` renamed to `drop`.
|
||||
* std: The `drop` method now takes `&mut self` instead of `&self`.
|
||||
* std: The prelude no longer reexports any modules, only types and traits.
|
||||
* std: The prelude no longer re-exports any modules, only types and traits.
|
||||
* std: Prelude additions: `print`, `println`, `FromStr`, `ApproxEq`, `Equiv`,
|
||||
`Iterator`, `IteratorUtil`, many numeric traits, many tuple traits.
|
||||
* std: New numeric traits: `Fractional`, `Real`, `RealExt`, `Integer`, `Ratio`,
|
||||
|
@ -15,7 +15,7 @@
|
||||
//!
|
||||
//! This library, like libcore, is not intended for general usage, but rather as
|
||||
//! a building block of other libraries. The types and interfaces in this
|
||||
//! library are reexported through the [standard library](../std/index.html),
|
||||
//! library are re-exported through the [standard library](../std/index.html),
|
||||
//! and should not be used through this library.
|
||||
//!
|
||||
//! ## Boxed values
|
||||
@ -52,7 +52,7 @@
|
||||
//! ## Collections
|
||||
//!
|
||||
//! Implementations of the most common general purpose data structures are
|
||||
//! defined in this library. They are reexported through the
|
||||
//! defined in this library. They are re-exported through the
|
||||
//! [standard collections library](../std/collections/index.html).
|
||||
//!
|
||||
//! ## Heap interfaces
|
||||
|
@ -16,7 +16,7 @@
|
||||
|
||||
#![stable(feature = "core_prelude", since = "1.4.0")]
|
||||
|
||||
// Reexported core operators
|
||||
// Re-exported core operators
|
||||
#[stable(feature = "core_prelude", since = "1.4.0")]
|
||||
#[doc(no_inline)]
|
||||
pub use marker::{Copy, Send, Sized, Sync};
|
||||
@ -24,12 +24,12 @@ pub use marker::{Copy, Send, Sized, Sync};
|
||||
#[doc(no_inline)]
|
||||
pub use ops::{Drop, Fn, FnMut, FnOnce};
|
||||
|
||||
// Reexported functions
|
||||
// Re-exported functions
|
||||
#[stable(feature = "core_prelude", since = "1.4.0")]
|
||||
#[doc(no_inline)]
|
||||
pub use mem::drop;
|
||||
|
||||
// Reexported types and traits
|
||||
// Re-exported types and traits
|
||||
#[stable(feature = "core_prelude", since = "1.4.0")]
|
||||
#[doc(no_inline)]
|
||||
pub use clone::Clone;
|
||||
@ -55,7 +55,7 @@ pub use option::Option::{self, Some, None};
|
||||
#[doc(no_inline)]
|
||||
pub use result::Result::{self, Ok, Err};
|
||||
|
||||
// Reexported extension traits for primitive types
|
||||
// Re-exported extension traits for primitive types
|
||||
#[stable(feature = "core_prelude", since = "1.4.0")]
|
||||
#[doc(no_inline)]
|
||||
pub use slice::SliceExt;
|
||||
|
@ -22,7 +22,7 @@
|
||||
// a lot of stuff defined here. Let's keep it clean.
|
||||
//
|
||||
// Since slices don't support inherent methods; all operations
|
||||
// on them are defined on traits, which are then reexported from
|
||||
// on them are defined on traits, which are then re-exported from
|
||||
// the prelude for convenience. So there are a lot of traits here.
|
||||
//
|
||||
// The layout of this file is thus:
|
||||
|
@ -2119,7 +2119,7 @@ impl<'a> LoweringContext<'a> {
|
||||
|
||||
// Privatize the degenerate import base, used only to check
|
||||
// the stability of `use a::{};`, to avoid it showing up as
|
||||
// a reexport by accident when `pub`, e.g. in documentation.
|
||||
// a re-export by accident when `pub`, e.g. in documentation.
|
||||
let path = P(self.lower_path(id, &prefix, ParamMode::Explicit, true));
|
||||
*vis = hir::Inherited;
|
||||
hir::ItemUse(path, hir::UseKind::ListStem)
|
||||
|
@ -26,9 +26,9 @@ pub enum AccessLevel {
|
||||
// public, then type `T` is reachable. Its values can be obtained by other crates
|
||||
// even if the type itself is not nameable.
|
||||
Reachable,
|
||||
// Public items + items accessible to other crates with help of `pub use` reexports
|
||||
// Public items + items accessible to other crates with help of `pub use` re-exports
|
||||
Exported,
|
||||
// Items accessible to other crates directly, without help of reexports
|
||||
// Items accessible to other crates directly, without help of re-exports
|
||||
Public,
|
||||
}
|
||||
|
||||
|
@ -702,8 +702,8 @@ impl<'a, 'tcx> CrateMetadata {
|
||||
let vis = self.get_visibility(child_index);
|
||||
let is_import = false;
|
||||
callback(def::Export { def, ident, vis, span, is_import });
|
||||
// For non-reexport structs and variants add their constructors to children.
|
||||
// Reexport lists automatically contain constructors when necessary.
|
||||
// For non-re-export structs and variants add their constructors to children.
|
||||
// Re-export lists automatically contain constructors when necessary.
|
||||
match def {
|
||||
Def::Struct(..) => {
|
||||
if let Some(ctor_def_id) = self.get_struct_ctor_def_id(child_index) {
|
||||
|
@ -219,7 +219,7 @@ impl<'a, 'tcx> Visitor<'tcx> for EmbargoVisitor<'a, 'tcx> {
|
||||
hir::ItemExternCrate(..) => {}
|
||||
// All nested items are checked by visit_item
|
||||
hir::ItemMod(..) => {}
|
||||
// Reexports are handled in visit_mod
|
||||
// Re-exports are handled in visit_mod
|
||||
hir::ItemUse(..) => {}
|
||||
// The interface is empty
|
||||
hir::ItemGlobalAsm(..) => {}
|
||||
@ -1049,7 +1049,7 @@ impl<'a, 'tcx> Visitor<'tcx> for ObsoleteVisiblePrivateTypesVisitor<'a, 'tcx> {
|
||||
|
||||
fn visit_item(&mut self, item: &'tcx hir::Item) {
|
||||
match item.node {
|
||||
// contents of a private mod can be reexported, so we need
|
||||
// contents of a private mod can be re-exported, so we need
|
||||
// to check internals.
|
||||
hir::ItemMod(_) => {}
|
||||
|
||||
|
@ -46,8 +46,8 @@ pub enum ImportDirectiveSubclass<'a> {
|
||||
},
|
||||
GlobImport {
|
||||
is_prelude: bool,
|
||||
max_vis: Cell<ty::Visibility>, // The visibility of the greatest reexport.
|
||||
// n.b. `max_vis` is only used in `finalize_import` to check for reexport errors.
|
||||
max_vis: Cell<ty::Visibility>, // The visibility of the greatest re-export.
|
||||
// n.b. `max_vis` is only used in `finalize_import` to check for re-export errors.
|
||||
},
|
||||
ExternCrate(Option<Name>),
|
||||
MacroUse,
|
||||
@ -877,7 +877,7 @@ impl<'a, 'b:'a> ImportResolver<'a, 'b> {
|
||||
self.record_def(directive.id, PathResolution::new(module.def().unwrap()));
|
||||
}
|
||||
|
||||
// Miscellaneous post-processing, including recording reexports,
|
||||
// Miscellaneous post-processing, including recording re-exports,
|
||||
// reporting conflicts, and reporting unresolved imports.
|
||||
fn finalize_resolutions_in(&mut self, module: Module<'b>) {
|
||||
// Since import resolution is finished, globs will not define any more names.
|
||||
|
@ -82,9 +82,9 @@ pub fn try_inline(cx: &DocContext, def: Def, name: ast::Name)
|
||||
ret.extend(build_impls(cx, did));
|
||||
clean::ForeignTypeItem
|
||||
}
|
||||
// Never inline enum variants but leave them shown as reexports.
|
||||
// Never inline enum variants but leave them shown as re-exports.
|
||||
Def::Variant(..) => return None,
|
||||
// Assume that enum variants and struct types are reexported next to
|
||||
// Assume that enum variants and struct types are re-exported next to
|
||||
// their constructors.
|
||||
Def::VariantCtor(..) |
|
||||
Def::StructCtor(..) => return Some(Vec::new()),
|
||||
@ -365,7 +365,7 @@ fn build_module(cx: &DocContext, did: DefId) -> clean::Module {
|
||||
};
|
||||
|
||||
fn fill_in(cx: &DocContext, did: DefId, items: &mut Vec<clean::Item>) {
|
||||
// If we're reexporting a reexport it may actually reexport something in
|
||||
// If we're re-exporting a re-export it may actually re-export something in
|
||||
// two namespaces, so the target may be listed twice. Make sure we only
|
||||
// visit each node at most once.
|
||||
let mut visited = FxHashSet();
|
||||
|
@ -1286,9 +1286,9 @@ impl DocFolder for Cache {
|
||||
clean::ConstantItem(..) | clean::StaticItem(..) |
|
||||
clean::UnionItem(..) | clean::ForeignTypeItem
|
||||
if !self.stripped_mod => {
|
||||
// Reexported items mean that the same id can show up twice
|
||||
// Re-exported items mean that the same id can show up twice
|
||||
// in the rustdoc ast that we're looking at. We know,
|
||||
// however, that a reexported item doesn't show up in the
|
||||
// however, that a re-exported item doesn't show up in the
|
||||
// `public_items` map, so we can skip inserting into the
|
||||
// paths map if there was already an entry present and we're
|
||||
// not a public item.
|
||||
@ -1545,7 +1545,7 @@ impl Context {
|
||||
{
|
||||
// Stripped modules survive the rustdoc passes (i.e. `strip-private`)
|
||||
// if they contain impls for public types. These modules can also
|
||||
// contain items such as publicly reexported structures.
|
||||
// contain items such as publicly re-exported structures.
|
||||
//
|
||||
// External crates will provide links to these structures, so
|
||||
// these modules are recursed into, but not rendered normally
|
||||
@ -2008,7 +2008,7 @@ fn item_module(w: &mut fmt::Formatter, cx: &Context,
|
||||
if cx.shared.sort_modules_alphabetically {
|
||||
indices.sort_by(|&i1, &i2| cmp(&items[i1], &items[i2], i1, i2));
|
||||
}
|
||||
// This call is to remove reexport duplicates in cases such as:
|
||||
// This call is to remove re-export duplicates in cases such as:
|
||||
//
|
||||
// ```
|
||||
// pub mod foo {
|
||||
|
@ -55,7 +55,7 @@ pub struct RustdocVisitor<'a, 'tcx: 'a> {
|
||||
impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||
pub fn new(cstore: &'tcx CrateStore,
|
||||
cx: &'a core::DocContext<'a, 'tcx>) -> RustdocVisitor<'a, 'tcx> {
|
||||
// If the root is reexported, terminate all recursion.
|
||||
// If the root is re-exported, terminate all recursion.
|
||||
let mut stack = FxHashSet();
|
||||
stack.insert(ast::CRATE_NODE_ID);
|
||||
RustdocVisitor {
|
||||
@ -214,7 +214,7 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
|
||||
let imported_from = self.cx.tcx.original_crate_name(def_id.krate);
|
||||
let def = match self.cstore.load_macro_untracked(def_id, self.cx.sess()) {
|
||||
LoadedMacro::MacroDef(macro_def) => macro_def,
|
||||
// FIXME(jseyfried): document proc macro reexports
|
||||
// FIXME(jseyfried): document proc macro re-exports
|
||||
LoadedMacro::ProcMacro(..) => continue,
|
||||
};
|
||||
|
||||
|
@ -351,9 +351,9 @@ use prelude::v1::*;
|
||||
#[cfg(test)] extern crate test;
|
||||
#[cfg(test)] extern crate rand;
|
||||
|
||||
// We want to reexport a few macros from core but libcore has already been
|
||||
// We want to re-export a few macros from core but libcore has already been
|
||||
// imported by the compiler (via our #[no_std] attribute) In this case we just
|
||||
// add a new crate name so we can attach the reexports to it.
|
||||
// add a new crate name so we can attach the re-exports to it.
|
||||
#[macro_reexport(assert, assert_eq, assert_ne, debug_assert, debug_assert_eq,
|
||||
debug_assert_ne, unreachable, unimplemented, write, writeln, try)]
|
||||
extern crate core as __core;
|
||||
@ -390,7 +390,7 @@ mod macros;
|
||||
// The Rust prelude
|
||||
pub mod prelude;
|
||||
|
||||
// Public module declarations and reexports
|
||||
// Public module declarations and re-exports
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
pub use core::any;
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
|
@ -52,7 +52,7 @@
|
||||
//! # Prelude contents
|
||||
//!
|
||||
//! The current version of the prelude (version 1) lives in
|
||||
//! [`std::prelude::v1`], and reexports the following.
|
||||
//! [`std::prelude::v1`], and re-exports the following.
|
||||
//!
|
||||
//! * [`std::marker`]::{[`Copy`], [`Send`], [`Sized`], [`Sync`]}. The marker
|
||||
//! traits indicate fundamental properties of types.
|
||||
|
@ -14,17 +14,17 @@
|
||||
|
||||
#![stable(feature = "rust1", since = "1.0.0")]
|
||||
|
||||
// Reexported core operators
|
||||
// Re-exported core operators
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
#[doc(no_inline)] pub use marker::{Copy, Send, Sized, Sync};
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
#[doc(no_inline)] pub use ops::{Drop, Fn, FnMut, FnOnce};
|
||||
|
||||
// Reexported functions
|
||||
// Re-exported functions
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
#[doc(no_inline)] pub use mem::drop;
|
||||
|
||||
// Reexported types and traits
|
||||
// Re-exported types and traits
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
#[doc(no_inline)] pub use boxed::Box;
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
|
@ -23,7 +23,7 @@
|
||||
#![doc(hidden)]
|
||||
|
||||
|
||||
// Reexport some of our utilities which are expected by other crates.
|
||||
// Re-export some of our utilities which are expected by other crates.
|
||||
pub use panicking::{begin_panic, begin_panic_fmt, update_panic_count};
|
||||
|
||||
// To reduce the generated code of the new `lang_start`, this function is doing
|
||||
|
@ -33,7 +33,7 @@ use core::iter::FusedIterator;
|
||||
use core::fmt::{self, Write};
|
||||
use tables::{conversions, derived_property, general_category, property};
|
||||
|
||||
// stable reexports
|
||||
// stable re-exports
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
pub use core::char::{MAX, from_digit, from_u32, from_u32_unchecked};
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
@ -41,7 +41,7 @@ pub use core::char::{EscapeDebug, EscapeDefault, EscapeUnicode};
|
||||
#[stable(feature = "char_from_str", since = "1.20.0")]
|
||||
pub use core::char::ParseCharError;
|
||||
|
||||
// unstable reexports
|
||||
// unstable re-exports
|
||||
#[unstable(feature = "try_from", issue = "33417")]
|
||||
pub use core::char::CharTryFromError;
|
||||
#[unstable(feature = "decode_utf8", issue = "33906")]
|
||||
|
@ -17,7 +17,7 @@ use ext::base::ExtCtxt;
|
||||
use ptr::P;
|
||||
use symbol::{Symbol, keywords};
|
||||
|
||||
// Transitional reexports so qquote can find the paths it is looking for
|
||||
// Transitional re-exports so qquote can find the paths it is looking for
|
||||
mod syntax {
|
||||
pub use ext;
|
||||
pub use parse;
|
||||
|
@ -155,7 +155,7 @@ declare_features! (
|
||||
// OIBIT specific features
|
||||
(active, optin_builtin_traits, "1.0.0", Some(13231)),
|
||||
|
||||
// macro reexport needs more discussion and stabilization
|
||||
// macro re-export needs more discussion and stabilization
|
||||
(active, macro_reexport, "1.0.0", Some(29638)),
|
||||
|
||||
// Allows use of #[staged_api]
|
||||
|
@ -8,7 +8,7 @@
|
||||
// option. This file may not be copied, modified, or distributed
|
||||
// except according to those terms.
|
||||
|
||||
// Test that macro reexports item are gated by `macro_reexport` feature gate.
|
||||
// Test that macro re-exports item are gated by `macro_reexport` feature gate.
|
||||
|
||||
// aux-build:macro_reexport_1.rs
|
||||
// gate-test-macro_reexport
|
||||
|
@ -32,7 +32,7 @@ mod foo {
|
||||
fn foo() {}
|
||||
}
|
||||
|
||||
// these are public so the parent can reexport them.
|
||||
// these are public so the parent can re-export them.
|
||||
pub static reexported_a: isize = 0;
|
||||
pub fn reexported_b() {}
|
||||
pub struct reexported_c;
|
||||
|
@ -20,7 +20,7 @@
|
||||
|
||||
extern crate lint_unused_extern_crate5; //~ ERROR: unused extern crate
|
||||
|
||||
pub extern crate lint_unused_extern_crate4; // no error, it is reexported
|
||||
pub extern crate lint_unused_extern_crate4; // no error, it is re-exported
|
||||
|
||||
extern crate lint_unused_extern_crate3; // no error, it is used
|
||||
|
||||
|
@ -18,7 +18,7 @@
|
||||
// compile-fail/type-mismatch-same-crate-name.rs
|
||||
// but deals with the case where one of the crates
|
||||
// is only introduced as an indirect dependency.
|
||||
// and the type is accessed via a reexport.
|
||||
// and the type is accessed via a re-export.
|
||||
// This is similar to how the error can be introduced
|
||||
// when using cargo's automatic dependency resolution.
|
||||
|
||||
|
@ -8,7 +8,7 @@
|
||||
// option. This file may not be copied, modified, or distributed
|
||||
// except according to those terms.
|
||||
|
||||
// Tests that the reexports of `FnOnce` et al from the prelude work.
|
||||
// Tests that the re-exports of `FnOnce` et al from the prelude work.
|
||||
|
||||
// pretty-expanded FIXME #23616
|
||||
|
||||
|
@ -36,7 +36,7 @@ pub mod hidden {
|
||||
pub struct Wobble;
|
||||
|
||||
|
||||
// these should only be shown if they're reexported correctly
|
||||
// these should only be shown if they're re-exported correctly
|
||||
impl Qux for ::Foo {}
|
||||
impl Qux for Wobble {}
|
||||
impl ::Bark for Wobble {}
|
||||
|
@ -8,7 +8,7 @@
|
||||
// option. This file may not be copied, modified, or distributed
|
||||
// except according to those terms.
|
||||
|
||||
// Issue 46112: An extern crate pub reexporting libcore was causing
|
||||
// Issue 46112: An extern crate pub re-exporting libcore was causing
|
||||
// paths rooted from `std` to be misrendered in the diagnostic output.
|
||||
|
||||
// ignore-windows
|
||||
|
Loading…
Reference in New Issue
Block a user