Skip to content

Commit 710ce44

Browse files
committed
Docs: Fix typos, grammar, and formatting inconsistencies
1 parent 6b00cba commit 710ce44

File tree

6 files changed

+14
-14
lines changed

6 files changed

+14
-14
lines changed

doc/src/CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ your contribution so that it can be merged.
77

88
## Basic Setup
99

10-
To contribute, make sure your set up:
10+
To contribute, make sure you set up:
1111

1212
* Your username + email
1313
* Your `~/.gitconfig`
@@ -84,7 +84,7 @@ We also tell LFortran how to print the new token in *parser.cpp*.
8484

8585
:fontawesome-solid-code: *src/lfortran/parser/parser.cpp*
8686
```
87-
std:string token2text(const int token)
87+
std::string token2text(const int token)
8888
{
8989
switch (token) {
9090
T(TK_CARET, "^")
@@ -241,7 +241,7 @@ Interactive Fortran. Experimental prototype, not ready for end users.
241241
```
242242
## Reach Out
243243

244-
If you have any questions or need help, please ask as at our
244+
If you have any questions or need help, please ask us at our
245245
[mailinglist](https://groups.io/g/lfortran) or a
246246
[chat](https://lfortran.zulipchat.com/).
247247

doc/src/ansi.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@
117117
.ansi-underline {
118118
text-decoration: underline;
119119
}
120-
/* The following styles are deprecated an will be removed in a future version */
120+
/* The following styles are deprecated and will be removed in a future version */
121121
.ansibold {
122122
font-weight: bold;
123123
}

doc/src/built-in functions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Returns the tuple (x // y, x % y).
4949

5050
### exp(x)
5151

52-
- ****Parameter****
52+
- **Parameter**
5353
- x : floating point number (f32, f64)
5454
- **Returns** : floating point number (f32, f64) between [0.0, inf]
5555

@@ -108,7 +108,7 @@ Returns the remainder of x / y, or x when x is smaller than y. Both x and y shou
108108

109109
- **Parameters**
110110
- x : integer (i32, i64), floating point number (f32, f64), complex number (c32) or bool
111-
- y: integer (i32, i64), floating point number (f32, f64) or bool
111+
- y : integer (i32, i64), floating point number (f32, f64) or bool
112112
- **Returns** : integer (i32), floating point number (f32, f64) or a complex number
113113

114114
Returns x<sup>y</sup>. When x is of type bool, y must also be of the same type. If x is 32-bit complex number (c32), y can only be a 32-bit integer (i32).

doc/src/design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ are encouraged to use them independently for other applications and build tools
88
on top:
99

1010
* Abstract Syntax Tree (AST), module `lfortran.ast`: Represents any Fortran
11-
source code, strictly based on syntax, no semantic is included. The AST
11+
source code, strictly based on syntax, no semantics are included. The AST
1212
module can convert itself to Fortran source code.
1313

1414
* Abstract Semantic Representation (ASR), module `lfortran.asr`: Represents a valid

doc/src/installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Follow the steps below to install and run LPython on Linux, Windows or macOS.
4040
- Windows with WSL
4141
- Install Miniforge Prompt and add it to path:
4242
```bash
43-
wget https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh -O miniconda.sh
43+
wget https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh -O miniconda.sh
4444
bash miniconda.sh -b -p $HOME/conda_root
4545
export PATH="$HOME/conda_root/bin:$PATH"
4646
conda init bash # (shell name)
@@ -76,7 +76,7 @@ Follow the steps below to install and run LPython on Linux, Windows or macOS.
7676
- Generate the prerequisite files and build in Debug Mode:
7777

7878
```bash
79-
# if you are developing on top of a forked repository; please run following command first
79+
# if you are developing on top of a forked repository; please run the following command first
8080
# ./generate_default_tag.sh
8181
8282
@@ -108,7 +108,7 @@ Follow the steps below to install and run LPython on Linux, Windows or macOS.
108108
- Run the following commands to build the project:
109109
```bash
110110
./build0.sh
111-
cmake -DCMAKE_BUILD_TYPE=Debug -DWITH_LLVM=yes -DCMAKE_INSTALL_PREFIX=`pwd`/inst .\
111+
cmake -DCMAKE_BUILD_TYPE=Debug -DWITH_LLVM=yes -DCMAKE_INSTALL_PREFIX=`pwd`/inst .
112112
make -j8
113113
```
114114

@@ -134,7 +134,7 @@ Follow the steps below to install and run LPython on Linux, Windows or macOS.
134134
cd integration_tests
135135
./run_tests.py
136136
```
137-
- In case you have recently updated macOS, you may get a warning like below in some test cases:
137+
- In case you have recently updated macOS, you may get a warning like the one below in some test cases:
138138
```bash
139139
ld: warning: object file (test_list_index2.out.tmp.o) was built for newer macOS version (14.0) than being linked (13.3)
140140
```

doc/src/rebasing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ pick 663edf45b refactor
100100
# However, if you remove everything, the rebase will be aborted.
101101
#
102102
```
103-
We want to squash commits named `refactor`(squash: meld commit with previous one), and we want to rename(`reword`) commit named `Added add4.py`, so will change `pick` option on our commits and type `squash or s`, `reword or r`
103+
We want to squash commits named `refactor`(squash: meld the commit with the previous one), and we want to rename(`reword`) commit named `Added add4.py`, so will change `pick` option on our commits and type `squash or s`, `reword or r`
104104
```bash
105105
pick 132b89e0c Added add.py
106106
pick 75556f15c Added add2.py
@@ -143,7 +143,7 @@ Refactor
143143
# Untracked files:
144144
...
145145
```
146-
- second window: rename(reword) `Added add4.py`, you can edit the message as you want, I will rename it: `Added add4.py and edit it ` .
146+
- second window: rename(reword) `Added add4.py`, you can edit the message as you want, I will rename it to: `Added add4.py and edit it ` .
147147
```
148148
Added add4.py
149149
@@ -226,7 +226,7 @@ Date: Sat Jul 30 23:36:27 2022 +0200
226226
and if you want to push to the remote branch you must push with `--force` option.
227227

228228

229-
This [video](https://drive.google.com/file/d/1506h86_RLgwtjLi_uKWbdVNDsSVusIbr/view?usp=sharing) by *Naman Gera* he was rebasing a branch.
229+
In this [video](https://drive.google.com/file/d/1506h86_RLgwtjLi_uKWbdVNDsSVusIbr/view?usp=sharing), by *Naman Gera* he shows how to rebase a branch.
230230

231231
---
232232
# Merging

0 commit comments

Comments
 (0)