Add a note about empty string.

ryouze · Sep 25, 2024 · 4a85b03 · 4a85b03
1 parent edc68c4
commit 4a85b03
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/core/env.hpp b/src/core/env.hpp
@@ -17,6 +17,8 @@ namespace core::env {
  * @param name Name of the environment variable (e.g., "SHELL").
  *
  * @return Value of the environment variable if succeeded (e.g., "/bin/zsh"), std::nullopt otherwise.
+ *
+ * @note This might be an empty string if the environment variable is set but empty.
  */
 [[nodiscard]] std::optional<std::string> get_variable(const std::string &name);