You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Constants specific to the f64 double-precision floating point type.
Some of the std modules' documentation sound like documentation for the primitive type itself. Others do not. The std::slice and slice docs almost look like they are supposed to be identical but there are some minor (perhaps accidental) differences. std::ptr has some unique content that may be better fit for the pointer docs.
In general, I think the std docs should be very brief and primarily work as a signpost pointing to the primitive type docs. But of course they should also document the module itself, without sounding like "I am char". Some more specific conventions could be established.
The text was updated successfully, but these errors were encountered:
GuillaumeGomez
added
the
A-docs
Area: documentation for any part of the project, including the compiler, standard library, and tools
label
Jan 12, 2022
On a semi-related note, as I mentioned here it's IMO very confusing that on the page for pointer, the Primitive Type pointer methods list in fact includes all of *const T, *mut T, *const [T], and *mut [T], which leads to a large amount of duplicated method names in practice.
Summary of primitive types with corresponding std modules:
std
modulestd
module docs first lineSome of the std modules' documentation sound like documentation for the primitive type itself. Others do not. The
std::slice
andslice
docs almost look like they are supposed to be identical but there are some minor (perhaps accidental) differences.std::ptr
has some unique content that may be better fit for thepointer
docs.In general, I think the std docs should be very brief and primarily work as a signpost pointing to the primitive type docs. But of course they should also document the module itself, without sounding like "I am char". Some more specific conventions could be established.
The text was updated successfully, but these errors were encountered: