Closed
Description
I just answered a question on URLO about when to implement or not to implement Display
, and I noticed that the docs on the Display
trait are lacking.
In particular, I believe they should definitely point out that implementing Display
will give a type a .to_string()
method via the ToString
trait. This is important to keep in mind when you’re designing an API; it’s also the reason why in the standard library Path
doesn’t implement Display
directly (but offers a .display()
method): because converting Path
to String
is lossy or fallible, and an (implicitly) lossy to_string
method would not fit the API.
@rustbot label A-docs, C-enhancement, T-libs-api
Metadata
Metadata
Assignees
Labels
Area: Documentation for any part of the project, including the compiler, standard library, and toolsCategory: An issue proposing an enhancement or a PR with one.Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.Call for participation: Help is requested to fix this issue.Relevant to the library team, which will review and decide on the PR/issue.