Skip to content

Fix README grammar #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
davassi merged 1 commit into from
Jun 14, 2025
Merged

Fix README grammar #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ Example of usage of the library:
```

All that's needed is to get a new instance of the 'resolver' from a Session and hand over the expression to be analysed.
The library just returns a variant natural number, or a decimal number if one exists in the expression (i.e '2.1+1') or is present a trigonometric function (i.e. 1/cos(x+1)).
The library returns a natural number or a decimal number if the expression contains a decimal literal (e.g., '2.1+1') or includes a trigonometric function (e.g., 1/cos(x+1)).

## Variables

Yarer handles variables and functions. Here an example:
Yarer handles variables and functions. Here is an example:

```rust
let session = Session::init();
Expand All @@ -52,7 +52,7 @@ and of course, the expression can be re-evaluated if the variable changes.

## Casting

The result can be simply casted into a i32 or a f64 (if decimal) simply with
The result can be cast into an i32 or an f64 (if decimal) using

```rust
let result: Number = resolver.resolve().unwrap();
Expand All @@ -64,7 +64,7 @@ The result can be simply casted into a i32 or a f64 (if decimal) simply with

## CLI

Yarer can be used also from command line, and behaves in a very similar manner to GNU bc
Yarer can also be used from the command line and behaves similarly to GNU bc

```rust
$ yarer
Expand Down Expand Up @@ -215,7 +215,7 @@ Step 2 - RpnResolver: Using the Shunting Yard algorithm the token array is conve

Step 3 - RpnResolver: The resulting RPN (Reverse Polish Notation) expression is evaluated.

Worth to mention that the Session is responsible to store all variables (and constants) that are borrowed by all the RpnResolvers.
It's worth mentioning that the Session is responsible for storing all variables (and constants) that are borrowed by all the RpnResolvers.

## Contribution

Expand Down