`std::sync::poison` documentation typo

[jalil-salame]

Location

rust/library/std/src/sync/poison.rs

Lines 3 to 16 in bc4376f

	//! # Poisoning
	//!
	//! All synchronization objects in this module implement a strategy called "poisoning"
	//! where if a thread panics while holding the exclusive access granted by the primitive,
	//! the state of the primitive is set to "poisoned".
	//! This information is then propagated to all other threads
	//! to signify that the data protected by this primitive is likely tainted
	//! (some invariant is not being upheld).
	//!
	//! The specifics of how this "poisoned" state affects other threads
	//! depend on the primitive. See [#Overview] bellow.
	//!
	//! For the alternative implementations that do not employ poisoning,
	//! see `std::sys::nonpoisoning`.

Summary

The last line references the module std::sys::nonpoisoning, this is wrong, it should reference std::sync::nonpoisoning (notice the sys -> sync).

For the alternative implementations that do not employ poisoning, see std::sys::nonpoisoning.

Minor issue since this is a nightly only experimental API.

[SciMind2460]

@rustbot claim

This is labeled with E-easy, and that may indicate the need to clarify here that the linked pull request indicates that the module doesn't exist yet.

Through pull request linking, it appears the appropriate changes may happen correctly.

• The autoclosure of this issue does have some possibility of missing the option to simply remove the comment as a temporary fix to the documentation.

• I would have to research more about rust contributing, or get more experience contributing on rust to determine whether a new pull request that simply deletes the incorrect line from the comments would create too much confusion (for maintainers) in the merge process.

• I have not sufficiently studied the relevant materalials to make a new issue that clarifies easy temporary fix of removing comment line before probable autoclosure.