Merge pull request #47 from LechevSpace/add-rust-requirements

Add rust toolchain requirements

Author: de-vri-es

README.md

@@ -22,6 +22,9 @@ fn main() {
 
 Use the `python!{..}` macro to write Python code directly in your Rust code.
 
+_NOTE:_ Rust **nightly** toolchain is required. Feature `proc_macro_span` is still unstable, for more details check out [issue #54725 - 
+Tracking issue for `proc_macro::Span` inspection APIs](https://github.com/rust-lang/rust/issues/54725)
+
 ### Using Rust variables
 
 To reference Rust variables, use `'var`, as shown in the example above.

src/context.rs

@@ -128,7 +128,7 @@ impl Context {
 		}
 	}
 
-	/// Add a wrapped #[pyfunction] or #[pymodule] using its own `__name__`.
+	/// Add a wrapped `#[pyfunction]` or `#[pymodule]` using its own `__name__`.
 	///
 	/// Use this with `pyo3::wrap_pyfunction` or `pyo3::wrap_pymodule`.
 	///
@@ -158,7 +158,7 @@ impl Context {
 		self.add_wrapped_with_gil(Python::acquire_gil().python(), wrapper);
 	}
 
-	/// Add a wrapped #[pyfunction] or #[pymodule] using its own `__name__`.
+	/// Add a wrapped `#[pyfunction]` or `#[pymodule]` using its own `__name__`.
 	///
 	/// See [Context::add_wrapped].
 	pub fn add_wrapped_with_gil<'p>(&self, py: Python<'p>, wrapper: &impl Fn(Python) -> PyResult<&PyCFunction>) {

src/lib.rs

@@ -18,6 +18,9 @@
 //!
 //! Use the `python!{..}` macro to write Python code directly in your Rust code.
 //!
+//! _NOTE:_ Rust **nightly** toolchain is required. Feature `proc_macro_span` is still unstable,
+//! for more details check out [issue #54725](https://github.com/rust-lang/rust/issues/54725) - Tracking issue for `proc_macro::Span` inspection APIs
+//! 
 //! ## Using Rust variables
 //!
 //! To reference Rust variables, use `'var`, as shown in the example above.