Skip to content

Commit 2ea012e

Browse files
committed
Fix whitespace in docs
1 parent c31ca12 commit 2ea012e

File tree

4 files changed

+18
-18
lines changed

4 files changed

+18
-18
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ and should be written in the body of the ticket or PR under their own heading, l
142142
For instance:
143143
144144
> \#\# QA Notes
145-
>
145+
>
146146
> Calling `cabal haddock-project` should produce documentation for the whole cabal project with the following defaults enabled:
147147
> * Documentation lives in ./haddocks
148148
> * The file `./haddocks/index.html` should exist
@@ -408,7 +408,7 @@ Running workflow manually as discussed above requires you to supply two inputs:
408408
409409
Going via an example, imagine that Cabal only allows `tar` or version less then
410410
or equal to 0.6, and you want to bump it to 0.6. Then, to show that Validate
411-
succeeds with `tar` 0.6, you should input
411+
succeeds with `tar` 0.6, you should input
412412

413413
- `tar` to the "allow-newer line"
414414
- `tar ==0.6` to the "constraints line"

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,15 @@ Currently, we only provide binaries for `x86_64` platforms.
4343
```
4444
4545
Replace "Linux" with "Windows" or "macOS" as appropriate.
46-
46+
4747
The default Linux build is dynamically linked against `zlib`, `gmp` and `glibc`.
4848
You will need to have appropriate versions of these libraries installed to use it.
4949
Alternatively a statically linked "Linux-static" binary is also provided.
5050
5151
You might need to add the following to your `cabal.project` file
5252
if your build fails because of an out-of-date `Cabal` library:
5353
```
54-
allow-newer:
54+
allow-newer:
5555
*:Cabal,
5656
*:Cabal-syntax
5757

doc/cabal-commands.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1381,8 +1381,8 @@ to Hackage.
13811381

13821382
.. option:: -t TOKEN or -tTOKEN, --token=TOKEN
13831383

1384-
Your Hackage authentication token. You can create and delete
1385-
authentication tokens on Hackage's `account management page
1384+
Your Hackage authentication token. You can create and delete
1385+
authentication tokens on Hackage's `account management page
13861386
<https://hackage.haskell.org/users/account-management>`__.
13871387

13881388
.. option:: -u USERNAME or -uUSERNAME, --username=USERNAME
@@ -1416,8 +1416,8 @@ cabal report
14161416

14171417
.. option:: -t TOKEN or -tTOKEN, --token=TOKEN
14181418

1419-
Your Hackage authentication token. You can create and delete
1420-
authentication tokens on Hackage's `account management page
1419+
Your Hackage authentication token. You can create and delete
1420+
authentication tokens on Hackage's `account management page
14211421
<https://hackage.haskell.org/users/account-management>`__.
14221422

14231423
.. option:: -u USERNAME or -uUSERNAME, --username=USERNAME

doc/getting-started.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ Getting Started
44
Installing Cabal
55
----------------
66

7-
The easiest and recommended way to install the ``cabal`` command-line tool
8-
on Linux, macOS, FreeBSD or Windows is through `ghcup <https://www.haskell.org/ghcup/>`__.
7+
The easiest and recommended way to install the ``cabal`` command-line tool
8+
on Linux, macOS, FreeBSD or Windows is through `ghcup <https://www.haskell.org/ghcup/>`__.
99
It installs the “Haskell toolchain”, which includes Cabal,
10-
the Haskell compiler `GHC <https://www.haskell.org/ghc/>`__
10+
the Haskell compiler `GHC <https://www.haskell.org/ghc/>`__
1111
and optionally other useful Haskell tools.
1212

1313
Creating a new application
1414
--------------------------
1515

16-
We create a minimal Haskell application to get a quick overview
16+
We create a minimal Haskell application to get a quick overview
1717
of the ``cabal`` command-line tool:
1818

1919
1. How to initialize a Haskell package.
@@ -59,9 +59,9 @@ The ``myapp.cabal`` file is a package description file, commonly referred to as
5959
default-language: Haskell2010
6060
6161
It contains metadata (package name and version, author name, license, etc.) and sections
62-
to define package components. Components can be used to split large codebases into smaller,
62+
to define package components. Components can be used to split large codebases into smaller,
6363
more managable building blocks.
64-
A component can be of one of several types (executable, library, etc.) and describes,
64+
A component can be of one of several types (executable, library, etc.) and describes,
6565
among other things, the location of source files and its dependencies.
6666
The ``myapp.cabal`` file above defines a single component named ``myapp`` of the executable type.
6767
Inside the ``executable`` section, the ``build-depends`` field lists the dependencies of this component.
@@ -77,7 +77,7 @@ The ``app/Main.hs`` file is where your executable's code lives:
7777
main = putStrLn "Hello, Haskell!"
7878
7979
80-
To run the executable, switch into the application directory with ``cd myapp`` and run
80+
To run the executable, switch into the application directory with ``cd myapp`` and run
8181

8282
.. code-block:: console
8383
@@ -86,7 +86,7 @@ To run the executable, switch into the application directory with ``cd myapp`` a
8686
Hello, Haskell!
8787
8888
This command automatically determines if the executable needs to be (re)built
89-
before running the executable. With only one executable component in the package,
89+
before running the executable. With only one executable component in the package,
9090
``cabal run`` (without a component name) is smart enough to infer it, so the name can be omitted.
9191

9292
If you just want to build the executable without running it, run:
@@ -181,11 +181,11 @@ Now you can build and re-run your code to see the new output:
181181
Running a single-file Haskell script
182182
------------------------------------
183183

184-
Cabal also supports running single-file Haskell scripts like
184+
Cabal also supports running single-file Haskell scripts like
185185
the following file named ``myscript``:
186186

187187
.. code-block:: haskell
188-
188+
189189
#!/usr/bin/env cabal
190190
{- cabal:
191191
build-depends:

0 commit comments

Comments
 (0)