FIX - Document mocked Span::start and Span::end methods

Helps dtolnay#237 **What it does:** - Adds warning on methods `Span::start` and `Span::end` methods
Elrendio · Nov 10, 2020 · 702c248 · 702c248
1 parent d2c09ab
commit 702c248
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -436,7 +436,8 @@ impl Span {
 
     /// Get the starting line/column in the source file for this span.
     ///
-    /// This method requires the `"span-locations"` feature to be enabled.
+    /// This method requires the `"span-locations"` feature to be enabled and to be on `nightly`. On `stable` rust this
+    /// currently returns a mocked LineColumn (`LineColumn { line: 0, column: 0 }`).
     #[cfg(span_locations)]
     pub fn start(&self) -> LineColumn {
         let imp::LineColumn { line, column } = self.inner.start();
@@ -445,7 +446,8 @@ impl Span {
 
     /// Get the ending line/column in the source file for this span.
     ///
-    /// This method requires the `"span-locations"` feature to be enabled.
+    /// This method requires the `"span-locations"` feature to be enabled and to be on `nightly`. On `stable` rust this
+    /// currently returns a mocked LineColumn (`LineColumn { line: 0, column: 0 }`).
     #[cfg(span_locations)]
     pub fn end(&self) -> LineColumn {
         let imp::LineColumn { line, column } = self.inner.end();