From 79b4b4340008f4fdf0119f02c1424c2c76dbf2a7 Mon Sep 17 00:00:00 2001 From: Maximilian Roos Date: Sat, 3 Aug 2024 12:14:40 -0700 Subject: [PATCH] --- prqlc/prqlc/src/lib.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/prqlc/prqlc/src/lib.rs b/prqlc/prqlc/src/lib.rs index 79cffe0c6855..a03a8752e58c 100644 --- a/prqlc/prqlc/src/lib.rs +++ b/prqlc/prqlc/src/lib.rs @@ -131,11 +131,11 @@ pub(crate) mod utils; pub type Result = core::result::Result; -/// Get the version of the compiler. This is determined by, in order: +/// Get the version of the compiler. This is determined by the first of: /// - An optional environment variable `PRQL_VERSION_OVERRIDE`. Note that this -/// needs to be set the first time this function is called, since it's stored -/// in a static. -/// - The version defined by `git describe` +/// needs to be set before the first time this function is called, since it's +/// stored in a static. It's primarily useful for testing. +/// - The version returned by `git describe --tags` /// - The version in the cargo manifest pub fn compiler_version() -> &'static Version { static COMPILER_VERSION: OnceLock = OnceLock::new();