Skip to content

Commit 59b7a7a

Browse files
committed
fix spelling and usage, per Grammarly
1 parent 7abd89b commit 59b7a7a

1 file changed

Lines changed: 18 additions & 22 deletions

File tree

README.md

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ JSON in Java [package org.json]
77

88
# Overview
99

10-
[JSON](http://www.JSON.org/) is a light-weight language independent data interchange format.
10+
[JSON](http://www.JSON.org/) is a light-weight language-independent data interchange format.
1111

1212
The JSON-Java package is a reference implementation that demonstrates how to parse JSON documents into Java objects and how to generate new JSON documents from the Java classes.
1313

@@ -17,7 +17,7 @@ Project goals include:
1717
* Easy to build, use, and include in other projects
1818
* No external dependencies
1919
* Fast execution and low memory footprint
20-
* Maintain backwards compatibility
20+
* Maintain backward compatibility
2121
* Designed and tested to use on Java versions 1.6 - 1.11
2222

2323
The files in this package implement JSON encoders and decoders. The package can also convert between JSON and XML, HTTP headers, Cookies, and CDL.
@@ -26,7 +26,7 @@ The license includes this restriction: ["The software shall be used for good, no
2626

2727
**If you would like to contribute to this project**
2828

29-
Bug fixes, code improvements, and unit test coverage changes are welcome! Because this project is currrently in maintenance phase, the kinds of changes that can be accepted are limited. For more information, please read the [FAQ](https://github.com/stleary/JSON-java/wiki/FAQ).
29+
Bug fixes, code improvements, and unit test coverage changes are welcome! Because this project is currently in the maintenance phase, the kinds of changes that can be accepted are limited. For more information, please read the [FAQ](https://github.com/stleary/JSON-java/wiki/FAQ).
3030

3131
# Build Instructions
3232

@@ -61,7 +61,7 @@ public class Test {
6161
}
6262
````
6363

64-
*Excecute the Test file*
64+
*Execute the Test file*
6565
````
6666
java -cp .;json-java.jar Test
6767
````
@@ -73,14 +73,14 @@ java -cp .;json-java.jar Test
7373
````
7474

7575

76-
**Build tools for building the package and executing the unit tests**
76+
**Tools to build the package and execute the unit tests**
7777

78-
The test suite can be executed with Maven by running:
78+
Execute the test suite with Maven:
7979
```
8080
mvn clean test
8181
```
8282

83-
The test suite can be executed with Gradlew by running:
83+
Execute the test suite with Gradlew:
8484

8585
```
8686
gradlew clean build test
@@ -101,12 +101,12 @@ This package fully supports `Integer`, `Long`, and `Double` Java types. Partial
101101
for `BigInteger` and `BigDecimal` values in `JSONObject` and `JSONArray` objects is provided
102102
in the form of `get()`, `opt()`, and `put()` API methods.
103103

104-
Although 1.6 compatibility is currently supported, it is not a project goal and may be
104+
Although 1.6 compatibility is currently supported, it is not a project goal and might be
105105
removed in some future release.
106106

107107
In compliance with RFC8259 page 10 section 9, the parser is more lax with what is valid
108-
JSON than the Generator. For Example, the tab character (U+0009) is allowed when reading
109-
JSON Text strings, but when output by the Generator, tab is properly converted to \t in
108+
JSON then the Generator. For Example, the tab character (U+0009) is allowed when reading
109+
JSON Text strings, but when output by the Generator, the tab is properly converted to \t in
110110
the string. Other instances may occur where reading invalid JSON text does not cause an
111111
error to be generated. Malformed JSON Texts such as missing end " (quote) on strings or
112112
invalid number formats (1.2e6.3) will cause errors as such documents can not be read
@@ -119,7 +119,7 @@ Some notable exceptions that the JSON Parser in this library accepts are:
119119
* Numbers out of range for `Double` or `Long` are parsed as strings
120120

121121
Recent pull requests added a new method `putAll` on the JSONArray. The `putAll` method
122-
works similarly as other `put` mehtods in that it does not call `JSONObject.wrap` for items
122+
works similarly to other `put` methods in that it does not call `JSONObject.wrap` for items
123123
added. This can lead to inconsistent object representation in JSONArray structures.
124124

125125
For example, code like this will create a mixed JSONArray, some items wrapped, others
@@ -169,10 +169,10 @@ For example, <b>Cookie.java</b> is tested by <b>CookieTest.java</b>.
169169

170170
<b>General issues with unit testing are:</b><br>
171171
* Just writing tests to make coverage goals tends to result in poor tests.
172-
* Unit tests are a form of documentation - how a given method actually works is demonstrated by the test. So for a code reviewer or future developer looking at code a good test helps explain how a function is supposed to work according to the original author. This can be difficult if you are not the original developer.
172+
* Unit tests are a form of documentation - how a given method works is demonstrated by the test. So for a code reviewer or future developer looking at code a good test helps explain how a function is supposed to work according to the original author. This can be difficult if you are not the original developer.
173173
* It is difficult to evaluate unit tests in a vacuum. You also need to see the code being tested to understand if a test is good.
174-
* Without unit tests it is hard to feel confident about the quality of the code, especially when fixing bugs or refactoring. Good tests prevents regressions and keeps the intent of the code correct.
175-
* If you have unit test results along with pull requests, the reviewer has an easier time understanding your code and determining if the it works as intended.
174+
* Without unit tests, it is hard to feel confident about the quality of the code, especially when fixing bugs or refactoring. Good tests prevent regressions and keep the intent of the code correct.
175+
* If you have unit test results along with pull requests, the reviewer has an easier time understanding your code and determining if it works as intended.
176176

177177

178178
# Files
@@ -264,16 +264,12 @@ and artifactId "json". For example:
264264
it is not recommended for use.
265265
Java 1.6 compatability fixed, JSONArray.toList() and JSONObject.toMap(),
266266
RFC4180 compatibility, JSONPointer, some exception fixes, optional XML type conversion.
267-
Contains the latest code as of 7 Aug, 2016
267+
Contains the latest code as of 7 Aug 2016
268268
269-
20160212 Java 1.6 compatibility, OSGi bundle. Contains the latest code as of 12 Feb, 2016.
269+
20160212 Java 1.6 compatibility, OSGi bundle. Contains the latest code as of 12 Feb 2016.
270270
271-
20151123 JSONObject and JSONArray initialization with generics. Contains the
272-
latest code as of 23 Nov, 2015.
271+
20151123 JSONObject and JSONArray initialization with generics. Contains the latest code as of 23 Nov 2015.
273272
274273
20150729 Checkpoint for Maven central repository release. Contains the latest code
275-
as of 29 July, 2015.
274+
as of 29 July 2015.
276275
~~~
277-
278-
279-

0 commit comments

Comments
 (0)