From e301665b0f1148dda83b8c3da6af48a312b529b5 Mon Sep 17 00:00:00 2001 From: Andrew Walbran <qwandor@google.com> Date: Thu, 2 May 2019 17:03:09 +0000 Subject: [PATCH] [netstack3] Fix link and typo in documentation. Change-Id: I93ed2ef4f7bc012c52fd35dfa3756438d9ac11df --- src/connectivity/network/netstack3/docs/PUB_CRATE.md | 12 ++++++------ src/connectivity/network/netstack3/docs/README.md | 3 ++- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/src/connectivity/network/netstack3/docs/PUB_CRATE.md b/src/connectivity/network/netstack3/docs/PUB_CRATE.md index e6e752ea9b4..ab978a68769 100644 --- a/src/connectivity/network/netstack3/docs/PUB_CRATE.md +++ b/src/connectivity/network/netstack3/docs/PUB_CRATE.md @@ -17,12 +17,12 @@ situation in Rust is through "re-exports" - in the root, we write something like `crate::foo::bar::do_thing`. This works, but has two major downsides. First, there's no way, when looking at -an item declaration, whether it's marked `pub` because it's intended to be used -by other modules in the crate, or because it's going to be re-exported publicly. -Second, there's no way to enforce that we don't accidentally use some item which -is *not* re-exported in the API of one that is. So long as both are `pub`, the -compiler can't tell that one is re-exported and the other isn't. E.g., consider -this code: +an item declaration, to know whether it's marked `pub` because it's intended to +be used by other modules in the crate, or because it's going to be re-exported +publicly. Second, there's no way to enforce that we don't accidentally use some +item which is *not* re-exported in the API of one that is. So long as both are +`pub`, the compiler can't tell that one is re-exported and the other isn't. +E.g., consider this code: ```rust pub struct Foo; diff --git a/src/connectivity/network/netstack3/docs/README.md b/src/connectivity/network/netstack3/docs/README.md index 19844da2a8f..06112ed18a8 100644 --- a/src/connectivity/network/netstack3/docs/README.md +++ b/src/connectivity/network/netstack3/docs/README.md @@ -11,4 +11,5 @@ This directory contains documentation of various aspects of the netstack. Briefl - [`IP_TYPES.md`](./IP_TYPES.md) describes our use of types and traits to represent IP versions and addresses - [`PARSING_SERIALIZATION.md`](./PARSING_SERIALIZATION.md) describes how we parse and serialize packets, and how we manage packet buffers -- [`TYPES.md`](./TYPES.md) motivates our enthusiastic use of static typing +- [`PUB_CRATE.md`](./PUB_CRATE.md) describes how we use visibility modifiers. +- [`STATIC_TYPING.md`](./STATIC_TYPING.md) motivates our enthusiastic use of static typing -- GitLab