Skip to content

Commit d10c3dc

Browse files
committed
More language changes for docs
1 parent 4672798 commit d10c3dc

2 files changed

Lines changed: 16 additions & 16 deletions

File tree

md/guides/jdbi.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{{#unless website}}[![Build Status](https://travis-ci.org/jooby-guides/{{guide}}.svg?branch=master)](https://travis-ci.org/jooby-guides/{{guide}}){{/unless}}
22
# jdbi guide
33

4-
In this guide you will learn how to build a **JSON API** for ```Pets``` and persist them into a **relational database** using {{modlink "jdbi"}} module.
4+
In this guide you will learn how to build a **JSON API** for ```Pets``` and persist them into a **relational database** using the {{modlink "jdbi"}} module.
55

6-
[JDBI](http://jdbi.org/) is a SQL convenience library for Java. It attempts to expose relational database access in idiommatic Java, using collections, beans, and so on, while maintaining the same level of detail as JDBC. It exposes two different style APIs, a fluent style and a sql object style.
6+
[JDBI](http://jdbi.org/) is a SQL convenience library for Java. It attempts to expose relational database access in idiomatic Java, using collections, beans, and so on, while maintaining the same level of detail as JDBC. It exposes two different style APIs, a fluent style and a sql object style.
77

88
# requirements
99

10-
Make sure you have all these software installed it in your computer:
10+
Make sure you have the following installed on your computer:
1111

1212
* A text editor or IDE
1313
* {{java}} or later
@@ -21,7 +21,7 @@ Open a terminal/console and paste:
2121
mvn archetype:generate -B -DgroupId={{pkgguide}} -DartifactId={{guide}} -Dversion=1.0 -DarchetypeArtifactId=jooby-archetype -DarchetypeGroupId=org.jooby -DarchetypeVersion={{version}}
2222
```
2323

24-
Jump into the application:
24+
Enter the application directory:
2525

2626
```
2727
cd {{guide}}
@@ -41,7 +41,7 @@ Add the {{modlink "jackson"}} dependency to your project:
4141
</dependency>
4242
```
4343

44-
Got to `App.java` and add the module:
44+
Go to `App.java` and add the module:
4545

4646
```java
4747
import org.jooby.json.Jackson;
@@ -101,7 +101,7 @@ The ```mem``` or ```fs``` are special databases. In order to use them we need th
101101
</dependency>
102102
```
103103

104-
> **NOTE**: If you want to connect to `mySQL` database (or any other), then you'll have to add the ```mySQL Java Driver``` to your project and define the connection properties like:
104+
> **NOTE**: If you want to connect to a database other than the embedded ```mem``` or ```fs```, like e.g. `mySQL`, then you'll have to add the ```mySQL Java Driver``` to your project and define the connection properties like this:
105105
>
106106
> ```
107107
> db.url = "jdbc:mysql//localhost/pets"
@@ -113,7 +113,7 @@ The ```mem``` or ```fs``` are special databases. In order to use them we need th
113113
114114
We are going to create a database schema at application startup time:
115115
116-
* Define a `schema` property in ```conf/application.conf``` like:
116+
* Define a `schema` property in ```conf/application.conf``` like this:
117117
118118
```
119119
schema = """
@@ -160,7 +160,7 @@ With a database ready, we are going to build our *JSON API*.
160160
161161
## creating a repository
162162

163-
[The SQL Object API](http://jdbi.org/sql_object_overview/) provides a declarative mechanism for a common [JDBI](http://jdbi.org/) usage – creation of DAO type objects where one method generally equates to one SQL statement. To use the SQL Object API, create an interface annotated to declare the desired behavior, like so:
163+
[The SQL Object API](http://jdbi.org/sql_object_overview/) provides a declarative mechanism for a common [JDBI](http://jdbi.org/) usage – creation of DAO type objects where one method generally equates to one SQL statement. To use the SQL Object API, create an interface annotated to declare the desired behavior, like this:
164164

165165
```java
166166
{{source "PetRepository.java"}}
@@ -222,7 +222,7 @@ You'll see an error page because we didn't persist any pet yet. Let's see how to
222222

223223
## save a pet
224224

225-
So far, we see how to query pets by ID or listing all them, it is time to see how to creates a new pet:
225+
So far, we've seen how to query pets by ID or listing all them, it is time to see how to create a new pet:
226226

227227
```java
228228
{
@@ -291,7 +291,7 @@ So far, we see how to query pets by ID or listing all them, it is time to see ho
291291

292292
# quick preview
293293

294-
API is ready, let's see how it looks like:
294+
The API is ready, let's see how it looks like:
295295

296296
```java
297297
{
@@ -332,22 +332,22 @@ API is ready, let's see how it looks like:
332332
}
333333
```
334334

335-
Not bad, ugh?
335+
Not bad, huh?
336336

337-
Isn't, but did you see we have to repeat the `/api/pets` pattern for each of our routes?
337+
But did you notice that we have to repeat the `/api/pets` pattern for each of our routes?
338338

339339
Let's fix that with {{javadoc "Jooby" "use" "java.lang.String"}}:
340340

341341
```java
342342
{{source mainclass}}
343343
```
344344

345-
Better now! The ```use``` method has many meanings in **Jooby**, If we use pass a ```String``` we can group route under a same path pattern.
345+
That's better! The ```use``` method has many meanings in **Jooby**, If we use pass a ```String``` we can group routes under the same path pattern.
346346

347347
# conclusion
348348

349-
As you already see, building an API that saves data in a **database** is very simple. Code looks clean and simple thanks to {{modlink "jdbi"}} module.
349+
As you've already seen, building an API that saves data in a **database** is very easy. The code looks clean and simple thanks to the {{modlink "jdbi"}} module.
350350

351-
The {{modlink "jdbi"}} module makes perfect sense if you want to have full control on your SQL queries, or if you don't like **ORM** tools too.
351+
The {{modlink "jdbi"}} module makes perfect sense if you want to have full control of your SQL queries, or if you prefer not to use **ORM** tools.
352352

353353
{{> guides/guide.footer}}

md/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ getting started
5252
exploring the newly created project
5353
-----
5454

55-
A new directory was created: ```my-app```. Let's see how it looks like:
55+
A new directory was created: ```my-app```. Let's see what it looks like:
5656

5757
```bash
5858
.

0 commit comments

Comments
 (0)