Skip to content

Commit 6ff0fde

Browse files
committed
fix up a bunch of docs typos
1 parent 3dc131f commit 6ff0fde

12 files changed

+21
-21
lines changed

docs/actions.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ function that will be called if the associated route matches.
1111

1212
An *action function* is invoked with one argument, a [*request
1313
object*](#request-object), when processing a request. This object contains
14-
properties and methods that allow you to access data bout the request, like
15-
form paramters and URL parameters.
14+
properties and methods that allow you to access data about the request, like
15+
form parameters and URL parameters.
1616

1717
The request object is mutable, it's a place where you can store any data you
1818
want to share between your actions and views. Additionally, the request object
@@ -1293,7 +1293,7 @@ lua = [[
12931293
function app:default_route()
12941294
ngx.log(ngx.NOTICE, "User hit unknown path " .. self.req.parsed_url.path)
12951295

1296-
-- call the original implementaiton to preserve the functionality it provides
1296+
-- call the original implementation to preserve the functionality it provides
12971297
return lapis.Application.default_route(self)
12981298
end
12991299
]],
@@ -1400,7 +1400,7 @@ $self_ref{"original_request"}.
14001400

14011401
Lapis' default error page displays a full stack trace. Therefore, it is
14021402
recommended to replace it with a custom one in your production environments and
1403-
log the exception in the background to prevent leaking file pathes and function
1403+
log the exception in the background to prevent leaking file paths and function
14041404
names related to your application.
14051405

14061406
The [`lapis-exceptions`][2] module augments the error handler to records errors
@@ -1493,7 +1493,7 @@ either an application class or an instance. If there are any before filters in
14931493
`other_app`, every action of `other_app` will be be wrapped in a new function
14941494
that calls those before filters before calling the original function.
14951495

1496-
Options can either be provided in the arugment `opts`, or will be pulled from
1496+
Options can either be provided in the argument `opts`, or will be pulled from
14971497
`other_app`, with precedence going to the value provided in `opts` if provided.
14981498

14991499
Note that application instance configuration like `layout` and `views_prefix`
@@ -1502,7 +1502,7 @@ are not kept from the included application.
15021502
$options_table{
15031503
{
15041504
name = "path",
1505-
description = "If provided, every path copied over will be prefixed with the value of this option. It should start with a `/` and a trailing slash should be inlcuded if desired."
1505+
description = "If provided, every path copied over will be prefixed with the value of this option. It should start with a `/` and a trailing slash should be included if desired."
15061506
},
15071507
{
15081508
name = "name",
@@ -1525,7 +1525,7 @@ Returns `nil` if no action could be found.
15251525

15261526
Creates a subclass of the Application class. This method is only available on
15271527
the class object, not the instance. Instance fields can be provided as via the
1528-
`fields` arugment or by mutating the returned metatable object.
1528+
`fields` argument or by mutating the returned metatable object.
15291529

15301530
This method returns the newly created class object, and the metatable for any
15311531
instances of the class.

docs/command_line.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ help migrate`.
4343

4444
## Default Environment
4545

46-
Lapis will load your Applications's configuration by for an environment before
46+
Lapis will load your Application's configuration for an environment before
4747
executing a command. The default environment name in command line `development`
4848
unless otherwise overwritten.
4949

@@ -280,7 +280,7 @@ is stubbed as if requested through the OpenResty server)
280280

281281
This command will execute the request in either the default environment or the
282282
specified one. This is important to note if your request makes changes to the
283-
database. The simulate commannd **does not** run in the *test* environment
283+
database. The simulate command **does not** run in the *test* environment
284284
unless explicitly specified.
285285

286286
By default the command will print information about the response, like the

docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The default environment is used when you don't explicitly specify an
2121
environment. The following conditions are checked in order to determine the
2222
default environment:
2323

24-
1. When inside a of a test suite (supported environments: [Busted](http://olivinelabs.com/busted/)), the default environment is set to `test`
24+
1. When inside of a test suite (supported environments: [Busted](http://olivinelabs.com/busted/)), the default environment is set to `test`
2525
2. When a module named `lapis_environment` exists, the return value of that module is used as the default environment
2626
3. Otherwise, default environment is set to `development`
2727

docs/etlua_templates.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ responsibility to verify that valid markup is generated** by using the correct
3737
template tags in the correct locations.
3838

3939
If a malicious user is able to inject JavaScript or other unapproved markup
40-
into your page then they may be able to comprise your platform for other users,
40+
into your page then they may be able to compromise your platform for other users,
4141
including stealing sessions or performing unapproved authenticated actions.
4242

4343
The etlua tag `<%= lua_expression %>` will HTML escape the output such that it
@@ -268,7 +268,7 @@ by Lapis to be used as a view.
268268
* `element(name, ...)` -- renders an HTML element to the buffer with `name`, supporting the full HTML builder syntax for any nested functions
269269

270270
Note that when a helper renders to the buffer, there will be no return value.
271-
It is not necessary to use an etlua tag that will take print the output of the
271+
It is not necessary to use an etlua tag that will print the output of the
272272
function.
273273

274274
## `EtluaWidget` reference

docs/getting_started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ requests, database queries and other requests using the modules provided with
1111
OpenResty. Lua's coroutines allow you to write synchronous looking code that is
1212
event driven behind the scenes.
1313

14-
The web framework comes with a environment based configuration, URL routing,
14+
The web framework comes with an environment based configuration, URL routing,
1515
HTML templating, CSRF and session support, a relational database object
1616
relational mapper for working with models and a handful of other useful
1717
functions needed for developing websites and more
@@ -182,7 +182,7 @@ to that process if it exists.
182182

183183
Now that you know how to generate a new project and start and stop the server
184184
you're ready to start writing application code. This guide splits into two for
185-
Lua & MoonScript MoonScript and Lua.
185+
Lua and MoonScript.
186186

187187
* [Create an application with Lua][1]
188188
* [Create an application with MoonScript][2]

docs/input_validation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ if types.empty some_value
358358
#### `types.valid_text`
359359

360360
Matches a string that is valid UTF8. Invalid characters sequences or
361-
unprintable characters will cause validation to valid.
361+
unprintable characters will cause validation to fail.
362362

363363
$dual_code{
364364
moon = [[

docs/lapis_console.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ every environment, or you can name an environment.
5959

6060
## Tips
6161

62-
The console lets your write and execute a MoonScript program. Multiple lines
62+
The console lets you write and execute a MoonScript program. Multiple lines
6363
are supported.
6464

6565
The `print` function has been replaced in the console to print to the debug

docs/lua_creating_configurations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,6 @@ This results in the following two configurations (default values omitted):
6666
}
6767
```
6868

69-
You can call the `config` function as many time you like on the same
69+
You can call the `config` function as many times as you like on the same
7070
configuration names, each time the passed in table is merged into the
7171
configuration.

docs/lua_getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ you must enable it by calling the `enable` method on your application instance.
136136

137137
The `render` parameter of the action's return value instructs Lapis which
138138
template to use when rendering the page. In this case `"index"` refers to the
139-
module with the name `views.index`. `etalua` injects itself into Lua's
139+
module with the name `views.index`. `etlua` injects itself into Lua's
140140
`require` method and so when the module `views.index` is loaded, an attempt to
141141
read and parse the file `views/index.etlua` is made.
142142

docs/quick_reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ class App extends lapis.Application
115115
```
116116

117117

118-
## How to do I render JSON?
118+
## How do I render JSON?
119119

120120
Use the `json` option of the `write` method, or the action's return value:
121121

0 commit comments

Comments
 (0)