about summary refs log tree commit diff
path: root/src/rustllvm/RustWrapper.cpp
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2017-06-09 04:09:39 +0000
committerbors <bors@rust-lang.org>2017-06-09 04:09:39 +0000
commit2416e222ecae76a36e958a8f7c4ac8083eb1ca45 (patch)
tree482318ec46881f04b96bc0f9721f53134733c812 /src/rustllvm/RustWrapper.cpp
parent9454dd5d2d8786d6eef07e2a7b737ad092e303df (diff)
parent2da350168df9dc51806fc72040a1022d45431879 (diff)
downloadrust-2416e222ecae76a36e958a8f7c4ac8083eb1ca45.tar.gz
rust-2416e222ecae76a36e958a8f7c4ac8083eb1ca45.zip
Auto merge of #42027 - mjkillough:typedef_assoc_items, r=QuietMisdreavus
Document direct implementations on type aliases.

This improves #32077, but is not a complete fix.

For a type alias `type NewType = AliasedType`, it will include any `impl NewType` and `impl
Trait for NewType` blocks in the documentation for `NewType`.

A complete fix would include the implementations from the aliased type in the type alias' documentation, so that users have a complete picture of methods that are available on the alias. However, to do this properly would require a fix for #14072, as the alias may affect the type parameters of the type alias, making the documentation difficult to understand. (That is, for `type Result = std::result::Result<(), ()>` we would ideally show documentation for `impl Result<(), ()>`, rather than generic documentation for `impl<T, E> Result<T, E>`).

I think this improvement is worthwhile, as it exposes implementations which are not currently documented by rustdoc. The documentation for the implementations on the aliased type are still accessible by clicking through to the docs for that type. (Although perhaps it's now less obvious to the user that they should click-through to get there).
Diffstat (limited to 'src/rustllvm/RustWrapper.cpp')
0 files changed, 0 insertions, 0 deletions