Skip to content

Commit 1276a49

Browse files
authored
Fix a few typos in docs and docstrings (#638)
* Fix typo in Security.md * Fix typo in tutorial Remove unnecessary close parenthesis ")". * Fix typos in Configuration.jl docstring * Fix typo in Exceptions.jl docstring * Update Generator.jl * Fix typo in Requests.jl docstring * Fix typo in Router.jl docstring * Fix typo in Util.jl docstrings
1 parent 43619eb commit 1276a49

8 files changed

+13
-13
lines changed

Security.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ involving the following steps:
5151
* Confirm the problem and determine the affected versions.
5252
* Audit code to find any potential similar problems.
5353
* Prepare fixes for all releases still under maintenance. These fixes will be
54-
released as fast as possible and will be available with latest tagged Genie version and annouced on [Genie's twitter](https://twitter.com/GenieMVC) and [Genie's Discord #announcement channel](https://discord.com/invite/9zyZbD6J7H).
54+
released as fast as possible and will be available with latest tagged Genie version and announced on [Genie's twitter](https://twitter.com/GenieMVC) and [Genie's Discord #announcement channel](https://discord.com/invite/9zyZbD6J7H).
5555

5656
## Comments on this Policy
5757

5858
If you have suggestions on how this process could be improved please submit a
59-
pull request.
59+
pull request.

docs/src/tutorials/92--Deploying_Genie_Server_Apps_with_Nginx.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This tutorial shows how to host a Julia/Genie app on with Nginx.
55
## Prerequisites
66

77
To expose the app over the internet, one needs access to a server. This can be a local machine or a cloud instance such
8-
as AWS EC2 or a Google Cloud Compute Engine for example).
8+
as AWS EC2 or a Google Cloud Compute Engine for example.
99

1010
If using a local server, a static IP is needed to ensure continuous access to the app. Internet service provider generally
1111
charge a fee for such extra service.

src/Configuration.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ App configuration - sets up the app's defaults. Individual options are overwritt
139139
- `path_env::String`: the path to the environment files (default "<path_config>/env/")
140140
- `path_app::String`: the path to the app files (default "app/")
141141
- `html_parser_close_tag::String`: default " /". Can be changed to an empty string "" so the single tags would not be closed.
142-
- `webchannels_keepalive_frequency::Int`: default `30000`. Frequency in miliseconds to send keepalive messages to webchannel/websocket to keep the connection alive. Set to `0` to disable keepalive messages.
142+
- `webchannels_keepalive_frequency::Int`: default `30000`. Frequency in milliseconds to send keepalive messages to webchannel/websocket to keep the connection alive. Set to `0` to disable keepalive messages.
143143
"""
144144
Base.@kwdef mutable struct Settings
145145
server_port::Int = 8000 # default port for binding the web server

src/Exceptions.jl

+2-2
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ end
101101
"""
102102
InternalServerException(message::String)
103103
104-
External `InternalServerException` constructor accepting a custome message.
104+
External `InternalServerException` constructor accepting a custom message.
105105
"""
106106
InternalServerException(message::String) = InternalServerException(message, "", 500)
107107

@@ -170,4 +170,4 @@ Custom printing for `FileExistsException`
170170
"""
171171
Base.show(io::IO, ex::FileExistsException) = print(io, "FileExistsException: $(ex.path)")
172172

173-
end
173+
end

src/Generator.jl

+2-2
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ end
123123
"""
124124
write_resource_file(resource_path::String, file_name::String, resource_name::String) :: Bool
125125
126-
Generates all resouce files and persists them to disk.
126+
Generates all resource files and persists them to disk.
127127
"""
128128
function write_resource_file(resource_path::String, file_name::String, resource_name::String, resource_type::Symbol; pluralize::Bool = true) :: Bool
129129
resource_name = (pluralize ? (Inflector.to_plural(resource_name)) : resource_name) |> Inflector.from_underscores
@@ -413,7 +413,7 @@ function write_app_custom_files(path::String, app_path::String) :: Nothing
413413
# This file is autogenerated to run all tests in the context of your Genie app.
414414
# It is not necessary to edit this file.
415415
# To create tests, simply add `.jl` test files in the `test/` folder.
416-
# All `.jl` files in the `test/` folder will be automaticlaly executed by running `\$ julia --project runtests.jl`
416+
# All `.jl` files in the `test/` folder will be automatically executed by running `\$ julia --project runtests.jl`
417417
# If you want to selectively run tests, use `\$ julia --project runtests.jl test_file_1 test_file_2`
418418
419419
ENV["GENIE_ENV"] = "test"

src/Requests.jl

+2-2
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ end
136136
"""
137137
getpayload() :: Dict{Symbol,Any}
138138
139-
A dict representing the GET/query variables payload of the request (the part correspoding to `?foo=bar&baz=moo`)
139+
A dict representing the GET/query variables payload of the request (the part corresponding to `?foo=bar&baz=moo`)
140140
"""
141141
function getpayload() :: Dict{Symbol,Any}
142142
haskey(Router.params(), Genie.Router.PARAMS_GET_KEY) ? Router.params(Genie.Router.PARAMS_GET_KEY) : Dict{Symbol,Any}()
@@ -307,4 +307,4 @@ function currenturl(req::HTTP.Request = getrequest()) :: String
307307
req.target
308308
end
309309

310-
end
310+
end

src/Router.jl

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
Parses requests and extracts parameters, setting up the call variables and invoking
3-
the appropiate route handler function.
3+
the appropriate route handler function.
44
"""
55
module Router
66

@@ -341,7 +341,7 @@ end
341341

342342

343343
"""
344-
Gets the `Route` correspoding to `routename`
344+
Gets the `Route` corresponding to `routename`
345345
"""
346346
function get_route(route_name::Symbol; default::Union{Route,Nothing} = Route()) :: Route
347347
isroute(route_name) ?

src/Util.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ const walkdir = walk_dir
5959
"""
6060
filterwhitespace(s::String, allowed::Vector{Char} = Char[]) :: String
6161
62-
Removes whitespaces from `s`, whith the exception of the characters in `allowed`.
62+
Removes whitespaces from `s`, with the exception of the characters in `allowed`.
6363
"""
6464
function filterwhitespace(s::S, allowed::Vector{Char} = Char[])::String where {S<:AbstractString}
6565
filter(x -> (x in allowed) || ! isspace(x), string(s))

0 commit comments

Comments
 (0)