Skip to content

Commit 591c152

Browse files
committed
core: Cleanup task_local docs
1 parent f996b3a commit 591c152

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

src/libcore/task/local_data.rs

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,17 @@
22
33
Task local data management
44
5-
Allows storing boxes with arbitrary types inside, to be accessed anywhere
6-
within a task, keyed by a pointer to a global finaliser function. Useful
7-
for task-spawning metadata (tracking linked failure state), dynamic
8-
variables, and interfacing with foreign code with bad callback interfaces.
5+
Allows storing boxes with arbitrary types inside, to be accessed
6+
anywhere within a task, keyed by a pointer to a global finaliser
7+
function. Useful for dynamic variables, singletons, and interfacing
8+
with foreign code with bad callback interfaces.
99
10-
To use, declare a monomorphic global function at the type to store, and use
11-
it as the 'key' when accessing. See the 'tls' tests below for examples.
10+
To use, declare a monomorphic global function at the type to store,
11+
and use it as the 'key' when accessing. See the 'tls' tests below for
12+
examples.
1213
13-
Casting 'Arcane Sight' reveals an overwhelming aura of Transmutation magic.
14+
Casting 'Arcane Sight' reveals an overwhelming aura of Transmutation
15+
magic.
1416
1517
*/
1618

src/libcore/task/local_data_priv.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
#[doc(hidden)]; // FIXME #3538
2+
13
use local_data::LocalDataKey;
24

35
trait LocalData { }

0 commit comments

Comments
 (0)