From 7b418d3a8ceb6d84cdb6e80da7514dbd120c5e17 Mon Sep 17 00:00:00 2001
From: Tetsuharu Ohzeki <tetsuharu.ohzeki@gmail.com>
Date: Mon, 26 Jun 2023 17:05:13 +0900
Subject: [PATCH] Add the comment why `HasSource::source()` returns `Option`

---
 crates/hir/src/has_source.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/crates/hir/src/has_source.rs b/crates/hir/src/has_source.rs
index 63d11155c6a..b46a3856d45 100644
--- a/crates/hir/src/has_source.rs
+++ b/crates/hir/src/has_source.rs
@@ -21,6 +21,10 @@ pub trait HasSource {
     /// Fetches the definition's source node.
     /// Using [`crate::Semantics::source`] is preferred when working with [`crate::Semantics`],
     /// as that caches the parsed file in the semantics' cache.
+    ///
+    /// The current some implementations can return `InFile` instead of `Option<InFile>`.
+    /// But we made this method `Option` to support rlib in the future
+    /// by https://github.com/rust-lang/rust-analyzer/issues/6913
     fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>>;
 }