diff options
| -rw-r--r-- | crates/ide/src/doc_links.rs | 8 | ||||
| -rw-r--r-- | crates/ide/src/lib.rs | 5 |
2 files changed, 9 insertions, 4 deletions
diff --git a/crates/ide/src/doc_links.rs b/crates/ide/src/doc_links.rs index 5b67761acd4..8f7cd534a27 100644 --- a/crates/ide/src/doc_links.rs +++ b/crates/ide/src/doc_links.rs @@ -35,10 +35,10 @@ use crate::{ #[derive(Default, Debug, Clone, PartialEq, Eq)] pub struct DocumentationLinks { /// The URL to the documentation on docs.rs. - /// Could be invalid. + /// May not lead anywhere. pub web_url: Option<String>, /// The URL to the documentation in the local file system. - /// Could be invalid. + /// May not lead anywhere. pub local_url: Option<String>, } @@ -119,7 +119,7 @@ pub(crate) fn remove_links(markdown: &str) -> String { // Feature: Open Docs // -// Retrieve a link to documentation for the given symbol. +// Retrieve a links to documentation for the given symbol. // // The simplest way to use this feature is via the context menu. Right-click on // the selected item. The context menu opens. Select **Open Docs**. @@ -459,6 +459,8 @@ fn map_links<'e>( /// ```ignore /// https://doc.rust-lang.org/std/iter/trait.Iterator.html#tymethod.next /// ^^^^^^^^^^^^^^^^^^^^^^^^^^ +/// file:///project/root/target/doc/std/iter/trait.Iterator.html#tymethod.next +/// ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ /// ``` fn get_doc_base_urls( db: &RootDatabase, diff --git a/crates/ide/src/lib.rs b/crates/ide/src/lib.rs index 4e930cbc590..80f9707f9af 100644 --- a/crates/ide/src/lib.rs +++ b/crates/ide/src/lib.rs @@ -467,7 +467,10 @@ impl Analysis { self.with_db(|db| moniker::moniker(db, position)) } - /// Return URL(s) for the documentation of the symbol under the cursor. + /// Returns URL(s) for the documentation of the symbol under the cursor. + /// # Arguments + /// * `position` - Position in the file. + /// * `target_dir` - Directory where the build output is storeda. pub fn external_docs( &self, position: FilePosition, |