Skip to content

Commit a68dacb

Browse files
committed
Fix typos in documentation
1 parent e0fd08f commit a68dacb

22 files changed

+61
-61
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ there is ever a bad change, it can always be rolled back.
4646

4747
Stack's maintainers are long-term contributors to the project. Michael Snoyman
4848
(@snoyberg) was the founder of Stack, and its initial maintainer - and he has
49-
added others. Michael's current interests and priorties mean that he is no
49+
added others. Michael's current interests and priorities mean that he is no
5050
longer actively involved in adding new features to Stack.
5151

5252
Maintainers are recognized for their contributions including:
@@ -136,7 +136,7 @@ changes/additions based off the
136136
[stable branch](https://github.com/commercialhaskell/stack/tree/stable).
137137

138138
The specific versions of the online documentation (eg `v: v2.7.5`) are generated
139-
from the content of files at the point in the responsitory's history specified
139+
from the content of files at the point in the repository's history specified
140140
by the corresponding release tag. Consequently, that content is fixed once
141141
released.
142142

@@ -307,7 +307,7 @@ Where `<PATTERN>` is the name of the folder listed in the
307307
[test/integration/tests/](https://github.com/commercialhaskell/stack/tree/master/test/integration/tests)
308308
directory.
309309

310-
You may also achieve this through GHCi with tihs command:
310+
You may also achieve this through GHCi with this command:
311311

312312
~~~text
313313
stack ghci stack:stack-integration-test
@@ -341,9 +341,9 @@ This workflow will run if:
341341
* commits are pushed to these branches: `master`, `stable` and `rc/**`.
342342
* requested
343343

344-
The workflow has two jobs: `pendantic` and `unit-tests`.
344+
The workflow has two jobs: `pedantic` and `unit-tests`.
345345

346-
The `pendantic` job runs on `ubuntu` only and builds Stack with the
346+
The `pedantic` job runs on `ubuntu` only and builds Stack with the
347347
`--pedantic` flag.
348348

349349
The `unit-tests` job runs on a matrix of operating systems and Stack
@@ -356,7 +356,7 @@ systems. Its 'Cache dependencies on Windows' step caches the same information
356356
on Windows, but takes into account that a relevant directory is located outside
357357
of the Stack root.
358358

359-
### Integration-based - `intergration-tests.yml`
359+
### Integration-based - `integration-tests.yml`
360360

361361
This workflow will run if:
362362
* there is a pull request
@@ -397,7 +397,7 @@ named artifacts to path `_release`.
397397
Its step 'Hash and sign assets' makes use of a 'secret' environment variable
398398
`RELEASE_SIGNING_KEY` established by the owner of the Stack repository. The
399399
variable contains the private key for the GPG key with ID 0x575159689BEFB442.
400-
That key is imported into GPG and then used by GPG to create a detached signture
400+
That key is imported into GPG and then used by GPG to create a detached signature
401401
for each file.
402402

403403
### Inactive - `stan.yml`
@@ -408,7 +408,7 @@ workflow does not run. Its intent is to apply Stan to Stack.
408408

409409
## Slack channel
410410

411-
If you're making deep changes and real-time communcation with the Stack team
411+
If you're making deep changes and real-time communication with the Stack team
412412
would be helpful, we have a `#stack-collaborators` Slack channel in the
413413
Haskell Foundation workspace. To join the workspace, follow this
414414
[link](https://haskell-foundation.slack.com/join/shared_invite/zt-z45o9x38-8L55P27r12YO0YeEufcO2w#/shared-invite/email).

ChangeLog.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -165,14 +165,14 @@ Other enhancements:
165165
* Added `--candidate` flag to `upload` command to upload a package candidate
166166
rather than publishing the package.
167167

168-
* Error output using `--no-interleaved-output` no longer prepends indentating
168+
* Error output using `--no-interleaved-output` no longer prepends indenting
169169
whitespace. This allows emacs compilation-mode and vim quickfix to locate
170170
and track errors. See
171171
[#5523](https://github.com/commercialhaskell/stack/pull/5523)
172172

173173
Bug fixes:
174174

175-
* `stack new` now suppports branches other than `master` as default for
175+
* `stack new` now supports branches other than `master` as default for
176176
GitHub repositories. See
177177
[#5422](https://github.com/commercialhaskell/stack/issues/5422)
178178

@@ -250,7 +250,7 @@ Bug fixes:
250250
* Fix the problem of `stack repl foo:test:bar` failing without a project
251251
build before that. See
252252
[#5213](https://github.com/commercialhaskell/stack/issues/5213)
253-
* Fix `stack sdist` introducing unneded sublibrary syntax when using
253+
* Fix `stack sdist` introducing unnecessary sublibrary syntax when using
254254
pvp-bounds. See
255255
[#5289](https://github.com/commercialhaskell/stack/issues/5289)
256256

@@ -291,7 +291,7 @@ Release notes:
291291
* macOS: https://get.haskellstack.org/stable/osx-x86_64.tar.gz
292292
* Windows 64-bit: https://get.haskellstack.org/stable/windows-x86_64.zip
293293

294-
As always, binaries for specific versions are available from the Github
294+
As always, binaries for specific versions are available from the GitHub
295295
releases: https://github.com/commercialhaskell/stack/releases.
296296

297297
**Changes since v2.1.3.1**
@@ -573,7 +573,7 @@ Behavior changes:
573573
* Interleaved output is now turned on by default, see
574574
[#4702](https://github.com/commercialhaskell/stack/issues/4702). In
575575
addition, the `packagename> ` prefix is no longer included in
576-
interelaved mode when only building a single target.
576+
interleaved mode when only building a single target.
577577
* The `-fhide-source-paths` GHC option is now enabled by default and
578578
can be disabled via the `hide-source-paths` configuration option in
579579
`stack.yaml`. See
@@ -854,7 +854,7 @@ Behavior changes:
854854
optimizations/laziness. See:
855855
[#4125](https://github.com/commercialhaskell/stack/issues/4125).
856856
* Mustache templating is not applied to large files (over 50kb) to
857-
avoid performance degredation. See:
857+
avoid performance degradation. See:
858858
[#4133](https://github.com/commercialhaskell/stack/issues/4133).
859859
* `stack upload` signs the package by default, as documented. `--no-signature`
860860
turns the signing off.
@@ -890,7 +890,7 @@ Other enhancements:
890890
This should help with
891891
[#3510](https://github.com/commercialhaskell/stack/issues/3510).
892892
* `stack new` now allows template names of the form `username/foo` to
893-
download from a user other than `commercialstack` on Github, and can be
893+
download from a user other than `commercialstack` on GitHub, and can be
894894
prefixed with the service `github:`, `gitlab:`, or `bitbucket:`. See
895895
[#4039](https://github.com/commercialhaskell/stack/issues/4039)
896896
* Switch to `githash` to include some unmerged bugfixes in `gitrev`
@@ -1001,7 +1001,7 @@ Other enhancements:
10011001
that is compatible (rather than only checking a single one). This is
10021002
relevant on Linux where different distributions may have different
10031003
combinations of libtinfo 5/6, ncurses 5/6, and gmp 4/5, and will allow
1004-
simpifying the setup-info metadata YAML for future GHC releases.
1004+
simplifying the setup-info metadata YAML for future GHC releases.
10051005
* The build progress bar reports names of packages currently building.
10061006
* `stack setup --verbose` causes verbose output of GHC configure process.
10071007
See [#3716](https://github.com/commercialhaskell/stack/issues/3716)
@@ -1473,7 +1473,7 @@ Behavior changes:
14731473

14741474
* The default package metadata backend has been changed from Git to
14751475
the 01-index.tar.gz file, from the hackage-security project. This is
1476-
intended to address some download speed issues from Github for
1476+
intended to address some download speed issues from GitHub for
14771477
people in certain geographic regions. There is now full support for
14781478
checking out specific Cabal file revisions from downloaded tarballs
14791479
as well. If you manually specify a package index with only a Git
@@ -1940,7 +1940,7 @@ Other enhancements:
19401940
[#1620](https://github.com/commercialhaskell/stack/issues/1620)
19411941
* `DESTDIR` is filtered from environment when installing GHC. See
19421942
[#1460](https://github.com/commercialhaskell/stack/issues/1460)
1943-
* `stack haddock` now supports `--hadock-arguments`. See
1943+
* `stack haddock` now supports `--haddock-arguments`. See
19441944
[#2144](https://github.com/commercialhaskell/stack/issues/2144)
19451945
* Signing: warn if GPG_TTY is not set as per `man gpg-agent`
19461946

doc/GUIDE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,7 @@ We've specified the `acme-missiles` package in the `package.yaml` file (see
467467
above), but `acme-missiles` is not part of that LTS package set, so building
468468
failed.
469469

470-
To add `acme-missles` to the available packages, we'll use the `extra-deps` key
470+
To add `acme-missiles` to the available packages, we'll use the `extra-deps` key
471471
in the `stack.yaml` file. That key defines extra packages, not present in the
472472
resolver, that will be needed as dependencies. You can add this like so:
473473

@@ -496,7 +496,7 @@ You can also see a
496496
[list of all available snapshots](https://www.stackage.org/snapshots). You'll
497497
notice two flavors: LTS (for "Long Term Support") and Nightly. You can read more
498498
about them on the
499-
[LTS Haskell Github page](https://github.com/commercialhaskell/lts-haskell#readme).
499+
[LTS Haskell GitHub page](https://github.com/commercialhaskell/lts-haskell#readme).
500500
If you're not sure which to use, start with LTS Haskell (which Stack will lean
501501
towards by default as well).
502502

@@ -841,7 +841,7 @@ stack build --pedantic --haddock --test --exec "echo Yay, it succeeded" --file-w
841841

842842
This command will:
843843

844-
* turn on all warnings and errors (the `--pendantic` flag)
844+
* turn on all warnings and errors (the `--pedantic` flag)
845845
* build your library and executables
846846
* generate Haddocks (the `--haddock` flag)
847847
* build and run your test suite (the `--test` flag)
@@ -952,7 +952,7 @@ end up including the helloworld-test component as well.
952952

953953
You can bypass this implicit adding of components by being much more explicit,
954954
and stating the components directly. For example, the following will not build
955-
the `helloworld-exe` executable once all executables have been sucessfully
955+
the `helloworld-exe` executable once all executables have been successfully
956956
built:
957957

958958
~~~text
@@ -1307,7 +1307,7 @@ follows the Unix convention of `--` to separate these. For example, command:
13071307
stack exec --package stm -- echo I installed the stm package via --package stm
13081308
~~~
13091309

1310-
yields ouput like:
1310+
yields output like:
13111311

13121312
~~~text
13131313
Run from outside a project, using implicit global project config

doc/GUIDE_advanced.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ the command, see the [build command](build_command.md) documentation.
7878

7979
## The `stack config` commands
8080

81-
The `stack config` commands provide assistence with accessing or modifying
81+
The `stack config` commands provide assistance with accessing or modifying
8282
Stack's configuration. See `stack config` for the available commands.
8383

8484
## The `stack config env` command
@@ -310,7 +310,7 @@ All done.
310310

311311
The default templates repository is
312312
https://github.com/commercialhaskell/stack-templates. You can download templates
313-
from a different Github user by prefixing the username and a slash. Command:
313+
from a different GitHub user by prefixing the username and a slash. Command:
314314

315315
~~~text
316316
stack new my-yesod-project yesodweb/simple
@@ -518,7 +518,7 @@ For further information, see the [Azure CI](azure_ci.md) documentation.
518518

519519
### Travis
520520

521-
For futher information, see the [Travis CI](travis_ci.md) documentation.
521+
For further information, see the [Travis CI](travis_ci.md) documentation.
522522

523523
## Editor integration
524524

doc/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ stack exec my-project-exe
101101
- The `stack build` command will build the template project and create an
102102
executable named `my-project-exe` (on Windows, `my-project-exe.exe`). First,
103103
if necessary, Stack will download a version of GHC in an isolated location.
104-
That won't interfere with other GHC instalations on your system.
104+
That won't interfere with other GHC installations on your system.
105105
- The `stack exec my-project-exe` command will run (execute) the built
106106
executable, in Stack's environment.
107107

@@ -264,7 +264,7 @@ The following assumes that you already have installed a version of Stack and the
264264
cd stack
265265
~~~
266266
267-
3. Build the `stack` executable using a pre-existing installation of Stack with
267+
3. Build the `stack` executable using a preexisting installation of Stack with
268268
the command:
269269
270270
~~~text
@@ -280,7 +280,7 @@ The following assumes that you already have installed a version of Stack and the
280280
281281
Make sure the version is the latest one.
282282
283-
5. In the GitHub respository's issue tracker, look for issues tagged with
283+
5. In the GitHub repository's issue tracker, look for issues tagged with
284284
[newcomer friendly](https://github.com/commercialhaskell/stack/issues?q=is%3Aopen+is%3Aissue+label%3a%22newcomer+friendly%22)
285285
and
286286
[awaiting pull request](https://github.com/commercialhaskell/stack/issues?q=is%3Aopen+is%3Aissue+label%3A%22awaiting+pull+request%22)

doc/Stack_and_VS_Code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ necessary (they are not, if only Stack is being used).
8787

8888
For this workaround to work, however, there can be no differences between the
8989
version of GHC that the GHCup-supplied HLS was built with and the version that
90-
Stack has installed. A slight inconvenience here is also the posibility of false
90+
Stack has installed. A slight inconvenience here is also the possibility of false
9191
messages from the start-up that need to be ignored. In principle, those messages
9292
can be disabled by
9393
[setting the following](https://github.com/haskell/vscode-haskell#setting-a-specific-toolchain)

doc/azure/azure-pipelines.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
#
66
# https://docs.haskellstack.org/en/stable/azure_ci/
77
#
8-
# Copy these contents into the root directory of your Github project in a file
8+
# Copy these contents into the root directory of your GitHub project in a file
99
# named azure-pipelines.yml
1010
#
11-
# For better organization, you split various jobs into seprate parts
11+
# For better organization, you split various jobs into separate parts
1212
# and each of them are controlled via individual file.
1313
jobs:
1414
- template: azure-linux-template.yml

doc/azure/azure-simple.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
#
66
# https://docs.haskellstack.org/en/stable/azure_ci/
77
#
8-
# Copy these contents into the root directory of your Github project in a file
8+
# Copy these contents into the root directory of your GitHub project in a file
99
# named azure-pipelines.yml
1010

1111
# Choose a agent virtual image

doc/coverage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ When your project has these properties, you will get the following:
3636
2. A unified textual and HTML report, considering the coverage on all local
3737
libraries, based on all of the tests that were run.
3838

39-
3. An index of all generated HTML reports, in `index.html` in the the local
39+
3. An index of all generated HTML reports, in `index.html` in the local
4040
HPC root directory.
4141

4242
## The `stack hpc report` command

doc/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ circumstances, cause problems with building packages that make use of the GNU
398398
project's `autoconf` package and `configure` shell script files. It may be
399399
necessary to override the default location of Stack's programs folder. See the
400400
[local-programs-path](yaml_configuration.md#local-programs-path) option for more
401-
informaton.
401+
information.
402402

403403
See issue [#4726](https://github.com/commercialhaskell/stack/issues/4726).
404404

0 commit comments

Comments
 (0)