Add documentation for: file_source_root() #20680
Conversation
rustbot
added
the
S-waiting-on-review
crates/base-db/src/lib.rs
Outdated
| /// - `None` may occur if the | ||
| /// [`FileId`](https://docs.rs/ra_ap_vfs/latest/ra_ap_vfs/struct.FileId.html) | ||
| /// has been loaded into the VFS but was not registered with the | ||
| /// [`ra_ap_base_db::RootDatabase`](https://docs.rs/ra_ap_ide_db/latest/ra_ap_ide_db/struct.RootDatabase.html). | ||
| /// - See [rust-analyzer#20676](https://github.com/rust-lang/rust-analyzer/issues/20676) | ||
| /// for details and reproduction steps. | ||
| /// | ||
| /// To ensure proper registration, use | ||
| /// [`ra_ap_load_cargo::load_workspace()`](https://docs.rs/ra_ap_load-cargo/latest/ra_ap_load_cargo/fn.load_workspace.html). |
There was a problem hiding this comment.
That's not the right place to document this as nobody will see this except maybe r-a developers that don't need to.
If there is anything to change, it's the panic message, but as I said on that issue, I'm not sure we'd want even that: it's pretty expected that if you use the r-a API in incorrect ways you will get incorrect results.
There was a problem hiding this comment.
I am not a developer or a maintainer, but I still saw it somehow. In my opinion, it would be better for it to be there. Because I had to invest more time in ra_ap than I have anticipitated due to this error.
There was a problem hiding this comment.
Also, it would make sense for it be bug in production, but if there is another way to cause this behavior then I am not sure if this can already be considered UB.
There was a problem hiding this comment.
I agree we should have better documentation on using r-a APIs, but I don't think this is the place to do that. Perhaps in one of hir, ide-db, ide or load-cargo.
(And this cannot trigger UB by any way).
There was a problem hiding this comment.
I agree, then I will come up with a proposal soon.
YuraLitvinov
force-pushed
the
master
branch
from
f7e26a8 to
83981c1
Compare
rustbot
removed
the
S-waiting-on-review
Derived from this issue #20676