Skip to content

Commit 2a33c53

Browse files
author
Victor kariuki
committed
Pakeji Hisabati Documentation grammar corrections
1 parent e15a646 commit 2a33c53

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

third_party/math/README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,29 @@
11
# Pakeji Hisabati (Math Package)
22

3-
A math package written in pure Nuru by [VictorKariuki](https://github.com/VictorKariuki).
3+
Pakeji Hisabati is a math package written in pure Nuru by [VictorKariuki](https://github.com/VictorKariuki).
44

5-
This package provides various mathematical functions and constants implemented in a custom programming language. It includes methods for `trigonometric functions`, `logarithmic functions`, `array operations`, and `utility functions`.
5+
This package provides various mathematical functions and constants implemented in nuru programming language. It includes methods for `trigonometric functions`, `logarithmic functions`, `array operations`, and `utility functions`.
66

77

88
## Usage
9-
To use the `pakeji hisabati` package and its third-party packages, follow the steps below:
9+
To use the `pakeji hisabati` package follow the steps below:
1010

1111
1. Copy the `hisabati.nr` file and any required third-party package files into the same directory as your project.
1212

13-
2. Ensure that the third-party package file names end with the `.nr` extension and match the package names. For example, if the package name is `hisabati`, the corresponding file name should be `hisabati.nr`.
13+
2. Ensure that the package file names end with the `.nr` extension and match the package names. For example, if the package name is `hisabati`, the corresponding file name should be `hisabati.nr`.
1414

15-
3. You can directly import the `hisabati.nr` package and any required third-party packages in your Nuru code using the `ingiza` keyword. For example:
15+
3. You can directly import the `hisabati.nr` package and any required third-party packages in your Nuru code using the `tumia` keyword. For example:
1616

1717
```nuru
18-
tumia "hisabati.nr"
18+
tumia "hisabati"
1919
```
20-
Example of usage:
20+
Example of calling the package methods:
2121
```nuru
2222
andika(hisabati.e())
2323
2424
## What is in
25-
These package covers a wide range of mathematical operations, including `basic arithmetic`, `trigonometry`, `exponential and logarithmic functions`, `rounding and comparison operations`, as well as some `utility and array operations`.
25+
This package covers a wide range of mathematical operations, including `basic arithmetic`, `trigonometry`, `exponential and logarithmic functions`, `rounding and comparison operations`, as well as some `utility and array operations`.
2626
27-
28-
Here's an overview of the available methods and their functionalities:
2927
The methods provided in the `hisabati` package can be classified into different categories based on their functionalities. Here is a classification of the methods:
3028
3129
1. Trigonometric Functions:
@@ -83,11 +81,11 @@ The methods provided in the `hisabati` package can be classified into different
8381
- **phi**: Represents the `Golden Ratio`.
8482
- **ln10**: Represents the `natural logarithm of 10`.
8583
- **ln2**: Represents the `natural logarithm of 2`.
86-
- **log10e**: Represents the `base 10 logarithm` of Euler's number `(e)`.
84+
- **log10e**: Represents the `base 10 logarithms` of Euler's number `(e)`.
8785
- **log2e**: Represents the `base 2 logarithm` of Euler's number` (e)`.
8886
- **sqrt1_2**: Represents the `square root` of `1/2`.
8987
- **sqrt2**: Represents the `square root` of `2`.
90-
- **sqrt3**: Represents the `square root`of `3`.
88+
- **sqrt3**: Represents the `square root` of `3`.
9189
- **sqrt5**: Represents the `square root` of `5`.
9290
- **EPSILON**: Represents a small value (2.220446049250313e-16).
9391

0 commit comments

Comments
 (0)