Fix punctuation and grammar issues in guides #4811
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Gazler
reviewed
May 2, 2022
guides/deployment/heroku.md
Outdated
| @@ -211,7 +211,7 @@ When running a mix task later (after we have pushed the project to Heroku) you w | |||
| $ heroku run "POOL_SIZE=2 mix hello.task" | |||
| ``` | |||
|
|
|||
| So that Ecto does not attempt to open more than the available connections. | |||
| So that, Ecto does not attempt to open more than the available connections. | |||
There was a problem hiding this comment.
I don't think a comma is required here.
guides/howto/custom_error_pages.md
Outdated
| @@ -61,7 +61,7 @@ In other words, to provide custom error pages, we could simply define a proper ` | |||
|
|
|||
| But we can do even better. | |||
|
|
|||
| Phoenix generates an `ErrorView` for us, but it doesn't give us a `lib/hello_web/templates/error` directory. Let's create one now. Inside our new directory, let's add a template named`404.html.heex` and give it some markup – a mixture of our application layout and a new `<div>` with our message to the user. | |||
| Phoenix generates an `ErrorView` for us, but it doesn't give us a `lib/hello_web/templates/error` directory. Let's create one now. Inside our new directory, let's add a template named`404.html.eex` and give it some markup – a mixture of our application layout and a new `<div>` with our message to the user. | |||
guides/introduction/overview.md
Outdated
| @@ -1,6 +1,6 @@ | |||
| # Overview | |||
|
|
|||
| Phoenix is a web development framework written in Elixir which implements the server-side Model View Controller (MVC) pattern. Many of its components and concepts will seem familiar to those of us with experience in other web frameworks like Ruby on Rails or Python's Django. | |||
| Phoenix is a web development framework written in Elixir which implements the server-side Model View Controller (MVC) pattern. Many of its components and concepts will seem familiar to those of us with experience in other web frameworks like, Ruby on Rails or Python's Django. | |||
There was a problem hiding this comment.
I don't think a comma here is correct.
guides/introduction/overview.md
Outdated
| @@ -22,8 +22,8 @@ The guides that you are currently looking at provide an overview of all parts th | |||
|
|
|||
| * How-to's - a collection of articles on how to achieve certain things with Phoenix | |||
|
|
|||
| If you would prefer to read these guides as an EPUB [click here!](Phoenix.epub) | |||
| If you preferred to read these guides as an EPUB, [click here!](Phoenix.epub) | |||
guides/real_time/channels.md
Outdated
| @@ -404,11 +404,11 @@ defp put_user_token(conn, _) do | |||
| end | |||
| ``` | |||
|
|
|||
| Now our `conn.assigns` contains the `current_user` and `user_token`. | |||
| Now, our `conn.assigns` contains the `current_user` and `user_token`. | |||
guides/real_time/presence.md
Outdated
|
|
||
| The `onSync` callback allows you to easily react to presence state changes, which most often results in re-rendering an updated list of active users. You can use the `list` method to format and return each individual presence based on the needs of your application. | ||
|
|
||
| To iterate users, we use the `presences.list()` function which accepts a callback. The callback will be called for each presence item with 2 arguments, the presence id and a list of metas (one for each presence for that presence id). We use this to display the users and the number of devices they are online with. | ||
| To iterate users, we use the `presences.list()` function which, accepts a callback. The callback will be called for each presence item with 2 arguments, the presence id and a list of metas (one for each presence for that presence id). We use this to display the users and the number of devices they are online with. |
|
Thanks <3 |
chrismccord
pushed a commit
that referenced
this pull request
May 6, 2022
* Fixup grammar and punctuations issues * Apply PR suggestions
ryansch
pushed a commit
to outstand/phoenix
that referenced
this pull request
May 9, 2022
* Fixup grammar and punctuations issues * Apply PR suggestions
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix punctuation and grammar issues in guides