Skip to content

Commit 86a6949

Browse files
sublimeyeprescottprue
authored andcommitted
Minor grammar fixes in docs, recipes (prescottprue#243)
* docs(readme): Grammar fixes * docs(api,recipes): Grammar fixes * chore(gitignore): Ignore Jetbrains' project configuration files
1 parent 57990a0 commit 86a6949

File tree

14 files changed

+26
-25
lines changed

14 files changed

+26
-25
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,5 @@ _book
99
# Logs
1010
*.log
1111
.DS_Store
12+
.idea
1213
examples/complete/react-native/ios/build

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,18 +45,18 @@ npm install --save react-redux-firebase
4545

4646
The above install command will install the `@latest` tag. You may also use the following tags when installing to get different versions:
4747

48-
* `@next` - Next upcoming release. Currently points to active progress with `v1.5.0-*` pre-releases
49-
* `@canary` - Most possible up to date code. Currently points to active progress with `v2.0.0-*` pre-releases. *Warning:* Syntax is different than current stable version.
48+
* `@next` - Next upcoming release. Currently, points to active progress with `v1.5.0-*` pre-releases
49+
* `@canary` - Most possible up to date code. Currently, points to active progress with `v2.0.0-*` pre-releases. *Warning:* Syntax is different than current stable version.
5050

5151
Other versions docs are available using the dropdown on the above docs link. For quick access:
5252
* [Version `1.5.0` Docs](http://docs.react-redux-firebase.com/history/v1.5.0/)
5353
* [Version `2.0.0` Docs](http://docs.react-redux-firebase.com/history/v2.0.0/)
5454

55-
Be aware of changes when using version that are tagged `@latest`. Please report any issues you encounter, and try to keep an eye on the [releases page](https://github.com/prescottprue/react-redux-firebase/releases) for updates.
55+
Be aware of changes when using a version that is tagged `@latest`. Please report any issues you encounter, and try to keep an eye on the [releases page](https://github.com/prescottprue/react-redux-firebase/releases) for updates.
5656

5757
## Use
5858

59-
**Note:** If you are just starting a new project, you may want to use [`v2.0.0`](http://docs.react-redux-firebase.com/history/v2.0.0/#use) since it is has an even easier syntax. For clarity on the transition, view the [`v1` -> `v2` migration guide](http://docs.react-redux-firebase.com/history/v2.0.0/docs/v2-migration-guide.html)
59+
**Note:** If you are just starting a new project, you may want to use [`v2.0.0`](http://docs.react-redux-firebase.com/history/v2.0.0/#use) since it has an even easier syntax. For clarity on the transition, view the [`v1` -> `v2` migration guide](http://docs.react-redux-firebase.com/history/v2.0.0/docs/v2-migration-guide.html)
6060

6161
Include `reactReduxFirebase` in your store compose function and `firebaseStateReducer` in your reducers:
6262

@@ -204,7 +204,7 @@ export default class SomeComponent extends Component {
204204
}
205205
```
206206

207-
In order to enable this functionality, you will most likely need to install a plugin (depending on your build setup). For Webpack and Babel, you will need to make sure you have installed and enabled [babel-plugin-transform-decorators-legacy](https://github.com/loganfsmyth/babel-plugin-transform-decorators-legacy) by doing the following:
207+
To enable this functionality, you will most likely need to install a plugin (depending on your build setup). For Webpack and Babel, you will need to make sure you have installed and enabled [babel-plugin-transform-decorators-legacy](https://github.com/loganfsmyth/babel-plugin-transform-decorators-legacy) by doing the following:
208208

209209
1. run `npm i --save-dev babel-plugin-transform-decorators-legacy`
210210
2. Add the following line to your `.babelrc`:

docs/api/compose.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Middleware that handles configuration (placed in redux's
4848
profileParamsToPopulate config. (default: `true`)
4949
- `config.setProfilePopulateResults` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to
5050
call SET actions for data that results from populating profile to redux under
51-
the data path. For example: role paramter on profile populated from 'roles'
51+
the data path. For example role parameter on profile populated from 'roles'
5252
root. True will call SET_PROFILE as well as a SET action with the role that
5353
is loaded (places it in data/roles). (default: `false`)
5454

docs/api/constants.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Default configuration options
7171
profileParamsToPopulate config.
7272
- `setProfilePopulateResults` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** `true` Whether or not to
7373
call SET actions for data that results from populating profile to redux under
74-
the data path. For example: role paramter on profile populated from 'roles'
74+
the data path. For example role parameter on profile populated from 'roles'
7575
root. True will call SET_PROFILE as well as a SET action with the role that
7676
is loaded (places it in data/roles).
7777
- `distpatchOnUnsetListener` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** `false` Whether or not to

docs/api/helpers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Detect whether items are loaded yet or not
1717

1818
**Parameters**
1919

20-
- `item` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Item to check loaded status of. A comma seperated list is also acceptable.
20+
- `item` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Item to check loaded status of. A comma separated list is also acceptable.
2121

2222
**Examples**
2323

@@ -122,7 +122,7 @@ Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refer
122122
## orderedToJS
123123

124124
Convert parameter under "ordered" path of Immutable Map to a
125-
Javascript array. This preserves order set by query.
125+
Javascript array. This preserves order set by a query.
126126

127127
**Parameters**
128128

docs/api/props-firebase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
124124
## uniqueSet
125125

126126
Sets data to Firebase only if the path does not already
127-
exist, otherwise it rejects.
127+
exist. Otherwise, it rejects.
128128

129129
**Parameters**
130130

docs/recipes/epics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Epics are particularly useful for responding to actions (often described as a "sidecar").
33

44
## Setup
5-
Examples below assume that you have setup `redux-observable` middleware so that firebase is available within your epics. Here is an example `combineEpics` function that adds `getFirebase` as third argument along with an epic that uses it:
5+
Examples below assume that you have setup `redux-observable` middleware so that firebase is available within your epics. Here is an example `combineEpics` function that adds `getFirebase` as the third argument along with an epic that uses it:
66

77
```javascript
88
import { getFirebase } from 'react-redux-firebase'
@@ -20,7 +20,7 @@ const somethingEpic = (action$, store, getFirebase) =>
2020
```
2121

2222
### Debounced Notifications
23-
Debounce writing to a ref on Firebase such as `/notifications` (useful so that tons of similar notifications aren't created).
23+
Debounce is writing to a ref on Firebase such as `/notifications` (useful so that tons of similar notifications aren't created).
2424

2525
```js
2626
const SEND_NOTIFICATION = 'SEND_NOTIFICATION';

docs/recipes/profile.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ connect(({ firebase }) => ({
3535

3636
**NOTE:** This feature is only available in [`v1.5.*`](http://docs.react-redux-firebase.com/history/v1.5.0/docs/recipes/profile.html)
3737

38-
The current users profile can be updated by using the `updateProfile` method, which is [only available in `v1.5.*`](http://docs.react-redux-firebase.com/history/v1.5.0/docs/recipes/profile.html).
38+
Profile of the current user can be updated by using the `updateProfile` method, which is [only available in `v1.5.*`](http://docs.react-redux-firebase.com/history/v1.5.0/docs/recipes/profile.html).
3939

4040
## Change How Profiles Are Stored
4141
The way user profiles are written to the database can be modified by passing the `profileFactory` parameter.
@@ -60,7 +60,7 @@ const config = {
6060
To list online users and/or track sessions, view the [presence recipe](http://docs.react-redux-firebase.com/history/v2.0.0/docs/recipes/auth.html#list-of-online-users-presence)
6161

6262
## Populate Parameters
63-
If profile object contains an key or a list of keys as parameters, you can populate those parameters with the matching value from another location on firebase.
63+
If profile object contains a key or a list of keys as parameters, you can populate those parameters with the matching value from another location on firebase.
6464

6565
#### List
6666
profile.contacts contains a list of user UIDs that should be populated from the users list like so:

docs/recipes/roles.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ Though there are many patterns, we are going to use the following terminology:
66

77
**Role** - job function or title which defines authority level (i.e. admin or manager). A user has a role, a role as permissions.
88

9-
**Permissions** - approval of a mode of access (i.e. todos) . Multiple permissions can assigned to a single role.
9+
**Permissions** - approval of a mode of access (i.e. todos) . Multiple permissions can be assigned to a single role.
1010

1111
## Data Setup
1212

1313
Add the Roles collection in Firebase. It should be a sibling of the `users` collection. For example:
1414

15-
_Tip: you can import below JSON directly into Firebase. Alternatively you can populate it in the start of your application or when you deploy to Firebase._
15+
_Tip: you can import below JSON directly into Firebase. Alternatively, you can populate it in the start of your application or when you deploy to Firebase._
1616

1717
```js
1818
{
@@ -48,7 +48,7 @@ Each user should have a role parameter that correlates to a role. For example:
4848

4949
## Config
5050

51-
In order for us to check our role for permissions, we will want to populate the role on profile. This will turn the role string (i.e. admin) into the object representing that role from the roles collection.
51+
In order for us to check our role for permissions, we will want to populate the role on a profile. This will turn the role string (i.e. admin) into the object representing that role from the roles collection.
5252

5353
Make sure you have the following config when creating your store:
5454

@@ -78,7 +78,7 @@ reactReduxFirebase(
7878
)
7979
```
8080

81-
**Note:** beware that the `role` parameter on each user will remain a string, and won't actually be "converted" into a object. Something that may be apparant to some developers, but not to others ;-)
81+
**Note:** beware that the `role` parameter on each user will remain a string, and won't be "converted" into an object. Something that may be apparent to some developers, but not to others ;-)
8282

8383
## Automatically assign role when user signs up
8484

docs/recipes/routing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Routing Recipes
22

3-
These recipes assume that you are using [`react-router`](https://github.com/ReactTraining/react-router), but the principles should be applicable to any routing solution.
3+
These recipes assume that you are using [`react-router`](https://github.com/ReactTraining/react-router), but the principles should apply to any routing solution.
44

55
#### React Router 4
66

@@ -10,7 +10,7 @@ Progress on supporting react-router 4 [is tracked within this issue](https://git
1010

1111
## Basic
1212

13-
Routing can be changed based on data by using react lifecycle hooks such as `componentWillMount`, and `componentWillReceiveProps` to route users. This can be particularly useful when doing things such as route protection (only allowing user to view a route if they are logged in):
13+
Routing can be changed based on data by using react lifecycle hooks such as `componentWillMount`, and `componentWillReceiveProps` to route users. This can be particularly useful when doing things such as route protection (only allowing a user to view a route if they are logged in):
1414

1515
```javascript
1616
import React, { Component, PropTypes } from 'react'

0 commit comments

Comments
 (0)