rustdoc icon indicating copy to clipboard operation
rustdoc copied to clipboard

Does `rls-analysis` support everything we need?

Open steveklabnik opened this issue 7 years ago • 6 comments

Upstream wants to work with us, but we haven't actually determined if we need anything yet.

This quest issue is both broad and specific. Someone wanting to close it out should:

  1. Work through all of the different kinds of information that we need out of rls-analysis.
  2. Inspect its API to figure out if it all exists or not.

If we don't have all of the stuff we need, we'll have to open issues with upstream and work with them to get the information landed.

steveklabnik avatar Jul 11 '17 22:07 steveklabnik

After a quick look at generated JSON, it looks like the exported macros (and their doc comments) are not included.

But I'm not familiar enough with the save-analysis part of rust to be sure if this is a mistake on my part or if this is really not included.

dzamlo avatar Jul 16 '17 23:07 dzamlo

@steveklabnik It seems that rls-analysis does not export the visibility of items? We shouldn't be documenting private items :) (Found this while working on a PR for just that)

euclio avatar Jul 26 '17 21:07 euclio

yeah, we should at least know if something is public or private; sounds like an important thing to sort out

steveklabnik avatar Jul 26 '17 21:07 steveklabnik

@euclio , it would be nice to be able to document private definitions too. Earlier discussion https://github.com/rust-lang/rust/issues/15347

typesanitizer avatar Jul 28 '17 03:07 typesanitizer

We ran into some issues implementing the DefKinds. The discussion was here. Essentially, rls-analysis still needs to be expanded for other items so we can implement everything.

mgattozzi avatar Sep 29 '17 18:09 mgattozzi

We will not be able to support pub use and reexports until https://github.com/nrc/rls-analysis/issues/123 is fixed.

euclio avatar Nov 28 '17 15:11 euclio