Skip to content

Commit 632a734

Browse files
committed
Fixed spelling in README.md
1 parent 87382bc commit 632a734

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ where `TARGET_NAME` is the name of your library/executable.
3737

3838
All functiononality can be included with `#include <finitediff.hpp>`.
3939

40-
The library provides three main function `finite_gradient`, `finite_jacobian`, and `finite_hessian`.
40+
The library provides three main functions `finite_gradient`, `finite_jacobian`, and `finite_hessian`.
4141

4242
#### `finite_gradient`:
4343

@@ -93,11 +93,11 @@ enum AccuracyOrder {
9393

9494
#### `eps`:
9595

96-
The parameter `eps` is the finite difference step size. Smaller values result in a more accuracate approximation, but too small of a value can result in large numerical error because the difference will be divided by a small number.
96+
The parameter `eps` is the finite difference step size. Smaller values result in a more accurate approximation, but too small of a value can result in a large numerical error because the difference will be divided by a small number.
9797

9898
## Dependencies
9999

100-
**All dependancies are downloaded through CMake** depending on the build options.
100+
**All dependencies are downloaded through CMake** depending on the build options.
101101
The following libraries are used in this project:
102102

103103
* [Eigen](https://eigen.tuxfamily.org/): linear algebra
@@ -110,13 +110,13 @@ The following libraries are used in this project:
110110
## <a name="unit_tests"></a>Unit Tests
111111

112112
We provide unit tests for ensuring the correctness of our functions.
113-
To enable the unit tests use the flag `-DFINITE_DIFF_BUILD_UNIT_TESTS=ON` with CMake.
113+
To enable the unit tests, use the flag `-DFINITE_DIFF_BUILD_UNIT_TESTS=ON` with CMake.
114114

115115
## Contributing
116116

117-
This project is open for contributors! Contibutions can come in the form of feature requests, bug fixes, documentation, tutorials and the like. We highly recommend to file an Issue first before submitting a Pull Request.
117+
This project is open to contributors! Contributions can come in the form of feature requests, bug fixes, documentation, tutorials and the like. We highly recommend filing an Issue first before submitting a Pull Request.
118118

119-
Simply fork this repository and make a Pull Request! We'd definitely appreciate:
119+
Simply fork this repository and make a Pull Request! We'd appreciate:
120120

121121
* Implementation of new features
122122
* Bug Reports

0 commit comments

Comments
 (0)