Skip to content

Commit 328236c

Browse files
AsnelChristianAsnelChristian
committed
Docs Update
1 parent 2aec3f6 commit 328236c

File tree

29 files changed

+326
-209
lines changed

29 files changed

+326
-209
lines changed

‎Metadata/README.rst‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎README.rst‎

Lines changed: 31 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,69 +5,78 @@ This repository is automatically generated. To do so, run ``./generate``. This w
55

66
The aspect tree is given below:
77

8-
- `Metadata <Metadata/README.rst>`_
8+
- `Metadata <Root/Metadata/README.rst>`_
99

1010

11-
- `CommitMessage <Metadata/CommitMessage/README.rst>`_
11+
- `CommitMessage <Root/Metadata/CommitMessage/README.rst>`_
1212

1313

14-
- `Body <Metadata/CommitMessage/Body/README.rst>`_
14+
- `Body <Root/Metadata/CommitMessage/Body/README.rst>`_
1515

1616

17-
- `Existence <Metadata/CommitMessage/Body/Existence/README.rst>`_
17+
- `Existence <Root/Metadata/CommitMessage/Body/Existence/README.rst>`_
1818

1919

20-
- `Length <Metadata/CommitMessage/Body/Length/README.rst>`_
20+
- `Length <Root/Metadata/CommitMessage/Body/Length/README.rst>`_
2121

2222

23-
- `Emptiness <Metadata/CommitMessage/Emptiness/README.rst>`_
23+
- `Emptiness <Root/Metadata/CommitMessage/Emptiness/README.rst>`_
2424

2525

26-
- `Shortlog <Metadata/CommitMessage/Shortlog/README.rst>`_
26+
- `Shortlog <Root/Metadata/CommitMessage/Shortlog/README.rst>`_
2727

2828

29-
- `ColonExistence <Metadata/CommitMessage/Shortlog/ColonExistence/README.rst>`_
29+
- `ColonExistence <Root/Metadata/CommitMessage/Shortlog/ColonExistence/README.rst>`_
3030

3131

32-
- `FirstCharacter <Metadata/CommitMessage/Shortlog/FirstCharacter/README.rst>`_
32+
- `FirstCharacter <Root/Metadata/CommitMessage/Shortlog/FirstCharacter/README.rst>`_
3333

3434

35-
- `Length <Metadata/CommitMessage/Shortlog/Length/README.rst>`_
35+
- `Length <Root/Metadata/CommitMessage/Shortlog/Length/README.rst>`_
3636

3737

38-
- `Tense <Metadata/CommitMessage/Shortlog/Tense/README.rst>`_
38+
- `Tense <Root/Metadata/CommitMessage/Shortlog/Tense/README.rst>`_
3939

4040

41-
- `TrailingPeriod <Metadata/CommitMessage/Shortlog/TrailingPeriod/README.rst>`_
41+
- `TrailingPeriod <Root/Metadata/CommitMessage/Shortlog/TrailingPeriod/README.rst>`_
4242

4343

44-
- `Redundancy <Redundancy/README.rst>`_
44+
- `Redundancy <Root/Redundancy/README.rst>`_
4545

4646

47-
- `Clone <Redundancy/Clone/README.rst>`_
47+
- `Clone <Root/Redundancy/Clone/README.rst>`_
4848

4949

50-
- `UnreachableCode <Redundancy/UnreachableCode/README.rst>`_
50+
- `UnreachableCode <Root/Redundancy/UnreachableCode/README.rst>`_
5151

5252

53-
- `UnreachableStatement <Redundancy/UnreachableCode/UnreachableStatement/README.rst>`_
53+
- `UnreachableStatement <Root/Redundancy/UnreachableCode/UnreachableStatement/README.rst>`_
5454

5555

56-
- `UnusedFunction <Redundancy/UnreachableCode/UnusedFunction/README.rst>`_
56+
- `UnusedFunction <Root/Redundancy/UnreachableCode/UnusedFunction/README.rst>`_
5757

5858

59-
- `UnusedImport <Redundancy/UnusedImport/README.rst>`_
59+
- `UnusedImport <Root/Redundancy/UnusedImport/README.rst>`_
6060

6161

62-
- `UnusedVariable <Redundancy/UnusedVariable/README.rst>`_
62+
- `UnusedVariable <Root/Redundancy/UnusedVariable/README.rst>`_
6363

6464

65-
- `UnusedGlobalVariable <Redundancy/UnusedVariable/UnusedGlobalVariable/README.rst>`_
65+
- `UnusedGlobalVariable <Root/Redundancy/UnusedVariable/UnusedGlobalVariable/README.rst>`_
6666

6767

68-
- `UnusedLocalVariable <Redundancy/UnusedVariable/UnusedLocalVariable/README.rst>`_
68+
- `UnusedLocalVariable <Root/Redundancy/UnusedVariable/UnusedLocalVariable/README.rst>`_
6969

7070

71-
- `UnusedParameter <Redundancy/UnusedVariable/UnusedParameter/README.rst>`_
71+
- `UnusedParameter <Root/Redundancy/UnusedVariable/UnusedParameter/README.rst>`_
7272

7373

74+
- `Spelling <Root/Spelling/README.rst>`_
75+
76+
77+
- `aspectsYEAH <Root/Spelling/aspectsYEAH/README.rst>`_
78+
79+
80+
- `coalaCorrect <Root/Spelling/coalaCorrect/README.rst>`_
81+
82+

‎Redundancy/Clone/README.rst‎

Lines changed: 0 additions & 70 deletions
This file was deleted.

‎Redundancy/README.rst‎

Lines changed: 0 additions & 29 deletions
This file was deleted.

‎Metadata/CommitMessage/Body/Existence/README.rst‎ renamed to ‎Root/Metadata/CommitMessage/Body/Existence/README.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
+-------------------------------------------+----------------------------+------------------------------------------------------------------+
2-
| ``Metadata.CommitMessage.Body.Existence`` | `Parent <../README.rst>`_ | `Index <//github.com/coala/aspect-docs/blob/master/README.rst>`_ |
3-
+-------------------------------------------+----------------------------+------------------------------------------------------------------+
1+
+------------------------------------------------+----------------------------+------------------------------------------------------------------+
2+
| ``Root.Metadata.CommitMessage.Body.Existence`` | `Parent <../README.rst>`_ | `Index <//github.com/coala/aspect-docs/blob/master/README.rst>`_ |
3+
+------------------------------------------------+----------------------------+------------------------------------------------------------------+
44

55
+---------------------+----------------------------------+
66
| **Sibling aspects** | `Length <../Length/README.rst>`_ |

‎Metadata/CommitMessage/Body/Length/README.rst‎ renamed to ‎Root/Metadata/CommitMessage/Body/Length/README.rst‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
+----------------------------------------+----------------------------+------------------------------------------------------------------+
2-
| ``Metadata.CommitMessage.Body.Length`` | `Parent <../README.rst>`_ | `Index <//github.com/coala/aspect-docs/blob/master/README.rst>`_ |
3-
+----------------------------------------+----------------------------+------------------------------------------------------------------+
1+
+---------------------------------------------+----------------------------+------------------------------------------------------------------+
2+
| ``Root.Metadata.CommitMessage.Body.Length`` | `Parent <../README.rst>`_ | `Index <//github.com/coala/aspect-docs/blob/master/README.rst>`_ |
3+
+---------------------------------------------+----------------------------+------------------------------------------------------------------+
44

55
+---------------------+----------------------------------------+
66
| **Sibling aspects** | `Existence <../Existence/README.rst>`_ |
@@ -10,11 +10,11 @@ Length
1010
======
1111
The length of your commit message body lines.
1212

13-
Settings
13+
Tastes
1414
========
1515

1616
+--------------------+-----------------------------------------------------------+-----------------------------------------------------------+
17-
| Setting | Meaning | Values |
17+
| Taste | Meaning | Values |
1818
+====================+===========================================================+===========================================================+
1919
| | | |
2020
|``max_body_length`` | The maximal number of characters the body may contain in | **72**, 50, 80 |
@@ -36,7 +36,8 @@ Example
3636

3737
.. code-block:: English
3838
39-
Some people just write very long commit messages. Too long. Way too much actually. If they would just break their lines!
39+
Some people just write very long commit messages. Too long.
40+
Way too much actually. If they would just break their lines!
4041
4142
4243
Importance

‎Metadata/CommitMessage/Body/README.rst‎ renamed to ‎Root/Metadata/CommitMessage/Body/README.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
+---------------------------------+----------------------------+------------------------------------------------------------------+
2-
| ``Metadata.CommitMessage.Body`` | `Parent <../README.rst>`_ | `Index <//github.com/coala/aspect-docs/blob/master/README.rst>`_ |
3-
+---------------------------------+----------------------------+------------------------------------------------------------------+
1+
+--------------------------------------+----------------------------+------------------------------------------------------------------+
2+
| ``Root.Metadata.CommitMessage.Body`` | `Parent <../README.rst>`_ | `Index <//github.com/coala/aspect-docs/blob/master/README.rst>`_ |
3+
+--------------------------------------+----------------------------+------------------------------------------------------------------+
44

55
+---------------------+----------------------------------------+--------------------------------------+
66
| **Sibling aspects** | `Emptiness <../Emptiness/README.rst>`_ | `Shortlog <../Shortlog/README.rst>`_ |

‎Metadata/CommitMessage/Emptiness/README.rst‎ renamed to ‎Root/Metadata/CommitMessage/Emptiness/README.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
+--------------------------------------+----------------------------+------------------------------------------------------------------+
2-
| ``Metadata.CommitMessage.Emptiness`` | `Parent <../README.rst>`_ | `Index <//github.com/coala/aspect-docs/blob/master/README.rst>`_ |
3-
+--------------------------------------+----------------------------+------------------------------------------------------------------+
1+
+-------------------------------------------+----------------------------+------------------------------------------------------------------+
2+
| ``Root.Metadata.CommitMessage.Emptiness`` | `Parent <../README.rst>`_ | `Index <//github.com/coala/aspect-docs/blob/master/README.rst>`_ |
3+
+-------------------------------------------+----------------------------+------------------------------------------------------------------+
44

55
+---------------------+------------------------------+--------------------------------------+
66
| **Sibling aspects** | `Body <../Body/README.rst>`_ | `Shortlog <../Shortlog/README.rst>`_ |

‎Metadata/CommitMessage/README.rst‎ renamed to ‎Root/Metadata/CommitMessage/README.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
+----------------------------+----------------------------+------------------------------------------------------------------+
2-
| ``Metadata.CommitMessage`` | `Parent <../README.rst>`_ | `Index <//github.com/coala/aspect-docs/blob/master/README.rst>`_ |
3-
+----------------------------+----------------------------+------------------------------------------------------------------+
1+
+---------------------------------+----------------------------+------------------------------------------------------------------+
2+
| ``Root.Metadata.CommitMessage`` | `Parent <../README.rst>`_ | `Index <//github.com/coala/aspect-docs/blob/master/README.rst>`_ |
3+
+---------------------------------+----------------------------+------------------------------------------------------------------+
44

55
+---------------------+
66
| **Sibling aspects** |

‎Metadata/CommitMessage/Shortlog/ColonExistence/README.rst‎ renamed to ‎Root/Metadata/CommitMessage/Shortlog/ColonExistence/README.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
+----------------------------------------------------+----------------------------+------------------------------------------------------------------+
2-
| ``Metadata.CommitMessage.Shortlog.ColonExistence`` | `Parent <../README.rst>`_ | `Index <//github.com/coala/aspect-docs/blob/master/README.rst>`_ |
3-
+----------------------------------------------------+----------------------------+------------------------------------------------------------------+
1+
+---------------------------------------------------------+----------------------------+------------------------------------------------------------------+
2+
| ``Root.Metadata.CommitMessage.Shortlog.ColonExistence`` | `Parent <../README.rst>`_ | `Index <//github.com/coala/aspect-docs/blob/master/README.rst>`_ |
3+
+---------------------------------------------------------+----------------------------+------------------------------------------------------------------+
44

55
+---------------------+--------------------------------------------------+----------------------------------+--------------------------------+--------------------------------------------------+
66
| **Sibling aspects** | `FirstCharacter <../FirstCharacter/README.rst>`_ | `Length <../Length/README.rst>`_ | `Tense <../Tense/README.rst>`_ | `TrailingPeriod <../TrailingPeriod/README.rst>`_ |
@@ -11,11 +11,11 @@ ColonExistence
1111
Some projects force to use colons in the commit message shortlog
1212
(first line).
1313

14-
Settings
14+
Tastes
1515
========
1616

1717
+-------------------+-----------------------------------------------------+-----------------------------------------------------+
18-
| Setting | Meaning | Values |
18+
| Taste | Meaning | Values |
1919
+===================+=====================================================+=====================================================+
2020
| | | |
2121
|``shortlog_colon`` | Whether or not the shortlog has to contain a colon. | **True**, False +

0 commit comments

Comments
 (0)