From 50f5f3cc70e014677cdfd3e8f1cdfa95ec538823 Mon Sep 17 00:00:00 2001 From: sofia Date: Wed, 9 Jul 2025 20:16:52 +0300 Subject: [PATCH] Update lib.rs docs --- reid/src/lib.rs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/reid/src/lib.rs b/reid/src/lib.rs index fd648a4..40bf229 100644 --- a/reid/src/lib.rs +++ b/reid/src/lib.rs @@ -8,6 +8,15 @@ //! Much of the syntax in Reid is directly inspired by rust, but mostly it is //! driven by simplicity. //! +//! Reid is currently able to (non-exhaustively): +//! - Do basic algebra (e.g. Add, Sub, Mult) +//! - Resolve complex one-liners correctly using PEDMAS (e.g. `5 + 2 * 5 - 5 * +//! 5` is calculated correctly) +//! - Declare and call functions with varying parameters and return types +//! - Perform type-checking and type-inference such that return-types and +//! parameter types must always match. +//! - Do simple logic-operations (e.g. If/And/Or) +//! //! Currently missing relevant features (TODOs) are: //! - Arrays //! - Structs (and custom types as such)