Skip to content

Commit 704b09c

Browse files
authored
Misc documentation tweaks (#252)
* added remark (issue #231) * fixed some typos
1 parent 9cf9a82 commit 704b09c

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

doc/events.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Events
88
| scrollOffset | integer | current number of pixels scrolled from the top |
99
| scrollThreshold | integer | threshold which marks the line from where IAS should start loading the next page |
1010

11-
Triggered when the visitors scrolls.
11+
Triggered when a visitor scrolls.
1212

1313
### load
1414

@@ -24,7 +24,7 @@ The load event object contains the following properties.
2424
|-----------|---------------|-------------------------|
2525
| event.url | string | url that will be loaded |
2626

27-
Using this event it is possible to change the requested url. This can be useful to append an arbitrary parameter to the requested url so the server can handle the request differently. For example to optimize the returned url by stripping everything outside the container element (header, footer, etc.).
27+
Using this event it is possible to change the requested url. This can be useful to append an arbitrary parameter to the requested url so the server can handle the request differently. For example to optimize the returned html by stripping everything outside the container element (header, footer, etc.).
2828

2929
```javascript
3030
ias.on('load', function(event) {
@@ -115,7 +115,7 @@ Triggered when the next page should be loaded. Happens before loading of the nex
115115

116116
With this event it is possible to cancel the loading of the next page. You can do this by returning `false` from your callback.
117117

118-
Say you want to stop loading more pages if you hit a certain url:
118+
Say for example you want to stop loading more pages if you hit a certain url:
119119

120120
```javascript
121121
ias.on('next', function(url) {

doc/extension-history.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,7 @@ Loads the previous page.
4646
```javascript
4747
jQuery.ias().prev();
4848
```
49+
50+
## Remarks
51+
52+
When using the history extension it is not possible to use IAS in a overflow div.

doc/methods.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Methods
33

44
### bind
55

6-
Binds IAS from to window or document events.
6+
Binds IAS to window or document events.
77

88
```javascript
99
jQuery.ias().bind();
@@ -15,15 +15,15 @@ Unbinds and destroys instance.
1515

1616
### extension
1717

18-
Adds a extension to Infinite AJAX Scroll.
18+
Adds an extension to Infinite AJAX Scroll.
1919

2020
```javascript
2121
jQuery.ias().extension(new anExtension());
2222
```
2323

2424
### initialize
2525

26-
Initializes Infinite AJAX Scroll. Normally this happens when the DOM is ready (`$(document).ready()`), but if you want to dynamically create an IAS instance after the this event, you can initialize it yourself using this method.
26+
Initializes Infinite AJAX Scroll. Normally this happens when the DOM is ready (`$(document).ready()`), but if you want to dynamically create an IAS instance after this event, you can initialize it yourself using this method.
2727

2828
```javascript
2929
jQuery.ias().initialize();

0 commit comments

Comments
 (0)