about summary refs log tree commit diff
path: root/compiler/rustc_llvm/llvm-wrapper/ArchiveWrapper.cpp
diff options
context:
space:
mode:
authorKevin Reid <kpreid@google.com>2021-10-13 08:46:34 -0700
committerKevin Reid <kpreid@google.com>2021-12-04 07:46:36 -0800
commit6fd5cf51c1528c16f8a186ced5d6d21b1d70e319 (patch)
tree7b11d73338ef78e2cbabedf073c3f52b2b033c06 /compiler/rustc_llvm/llvm-wrapper/ArchiveWrapper.cpp
parent887999d163bace7e79370b952bdd1f930ff4cdd5 (diff)
downloadrust-6fd5cf51c1528c16f8a186ced5d6d21b1d70e319.tar.gz
rust-6fd5cf51c1528c16f8a186ced5d6d21b1d70e319.zip
Add documentation to more `From::from` implementations.
For users looking at documentation through IDE popups, this gives them
relevant information rather than the generic trait documentation wording
“Performs the conversion”. For users reading the documentation for a
specific type for any reason, this informs them when the conversion may
allocate or copy significant memory versus when it is always a move or
cheap copy.

Notes on specific cases:
* The new documentation for `From<T> for T` explains that it is not a
  conversion at all.
* Also documented `impl<T, U> Into<U> for T where U: From<T>`, the other
  central blanket implementation of conversion.
* I did not add documentation to conversions of a specific error type to
  a more general error type.
* I did not add documentation to unstable code.

This change was prepared by searching for the text "From<... for" and so
may have missed some cases that for whatever reason did not match. I
also looked for `Into` impls but did not find any worth documenting by
the above criteria.
Diffstat (limited to 'compiler/rustc_llvm/llvm-wrapper/ArchiveWrapper.cpp')
0 files changed, 0 insertions, 0 deletions