Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarify /docs error message when target/doc does not exist (#14364)

Browse source 
This PR improves the error message shown by the `/docs` slash command
when indexing fails due to the absence of `target/doc`.

We now distinguish between the overall `target/doc` directory missing
and an individual crate directory missing beneath it.

Release Notes:

- N/A
This commit is contained in:
Marshall Bowers 2024-07-12 16:09:16 -04:00 • committed by GitHub
parent ca80343486
commit 85d77a3eec
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 10 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

13
crates/indexed_docs/src/providers/rustdoc.rs
View file

@ -60,11 +60,18 @@ impl IndexedDocsProvider for LocalRustdocProvider {
let crate_name = crate_name.clone(); let crate_name = crate_name.clone();
let item = item.cloned(); let item = item.cloned();
async move { async move {
let mut local_cargo_doc_path = cargo_workspace_root.join("target/doc"); let target_doc_path = cargo_workspace_root.join("target/doc");
local_cargo_doc_path.push(crate_name.as_ref()); let mut local_cargo_doc_path = target_doc_path.join(crate_name.as_ref());
if !fs.is_dir(&local_cargo_doc_path).await { if !fs.is_dir(&local_cargo_doc_path).await {
bail!("docs directory for '{crate_name}' does not exist. run `cargo doc`"); let cargo_doc_exists_at_all = fs.is_dir(&target_doc_path).await;
if cargo_doc_exists_at_all {
bail!(
"no docs directory for '{crate_name}'. if this is a valid crate name, try running `cargo doc`"
);
} else {
bail!("no cargo doc directory. run `cargo doc`");
}
} }
if let Some(item) = item { if let Some(item) = item {