Skip to content

Commit abe35df

Browse files
AsnelChristianAsnelChristian
committed
Docs Update
1 parent 97afab3 commit abe35df

File tree

11 files changed

+57
-44
lines changed

11 files changed

+57
-44
lines changed

‎README.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ The aspect tree is given below:
7171
- `UnusedParameter <Root/Redundancy/UnusedVariable/UnusedParameter/README.rst>`_
7272

7373

74+
- `Security <Root/Security/README.rst>`_
75+
76+
7477
- `Smell <Root/Smell/README.rst>`_
7578

7679

‎Root/Metadata/README.rst

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

5-
+---------------------+------------------------------------------+--------------------------------+--------------------------------------+
6-
| **Sibling aspects** | `Redundancy <../Redundancy/README.rst>`_ | `Smell <../Smell/README.rst>`_ | `Spelling <../Spelling/README.rst>`_ |
7-
+---------------------+------------------------------------------+--------------------------------+--------------------------------------+
5+
+---------------------+------------------------------------------+--------------------------------------+--------------------------------+--------------------------------------+
6+
| **Sibling aspects** | `Redundancy <../Redundancy/README.rst>`_ | `Security <../Security/README.rst>`_ | `Smell <../Smell/README.rst>`_ | `Spelling <../Spelling/README.rst>`_ |
7+
+---------------------+------------------------------------------+--------------------------------------+--------------------------------+--------------------------------------+
88

99
Metadata
1010
========

‎Root/Redundancy/README.rst

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

5-
+---------------------+--------------------------------------+--------------------------------+--------------------------------------+
6-
| **Sibling aspects** | `Metadata <../Metadata/README.rst>`_ | `Smell <../Smell/README.rst>`_ | `Spelling <../Spelling/README.rst>`_ |
7-
+---------------------+--------------------------------------+--------------------------------+--------------------------------------+
5+
+---------------------+--------------------------------------+--------------------------------------+--------------------------------+--------------------------------------+
6+
| **Sibling aspects** | `Metadata <../Metadata/README.rst>`_ | `Security <../Security/README.rst>`_ | `Smell <../Smell/README.rst>`_ | `Spelling <../Spelling/README.rst>`_ |
7+
+---------------------+--------------------------------------+--------------------------------------+--------------------------------+--------------------------------------+
88

99
Redundancy
1010
==========

‎Root/Security/README.rst

1.79 KB
Binary file not shown.

‎Root/Smell/ClassSmell/DataClump/README.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,8 @@ Example
3939
Integer age, String gender,
4040
String occupation, String city){
4141
42-
System.out.printf("Welcome %s %s, a %d-year-old %s " "from %s who works as a%s
43-
",firstName, lastName,
44-
age, gender, city, occupation);
42+
System.out.printf("Welcome %s %s, a %d-year-old %s ""from %s who works as a%s
43+
",firstName, lastName, age, gender, city, occupation);
4544
}
4645
4746

‎Root/Smell/ClassSmell/README.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ ClassSmell
1111
This aspect detects `code smells` or `bad smells` related to classes'
1212
definitions in your codebase.
1313

14-
Class-level code smells are simply code smells indicating poorly defined
15-
classes (including too large classes or God object, data clump feature
16-
envy etc...) in your source code.
14+
Class-level code smells indicate poorly defined classes (including too
15+
large classes or God object, data clump feature envy etc...) in your
16+
source code.
1717

1818
Subaspects
1919
==========
@@ -35,16 +35,16 @@ Example
3535
Importance
3636
==========
3737

38-
These classes (the classes containing code smells) should be
39-
refactored for better readability and maintainability of your source
40-
code.
38+
These classes should be refactored for better readability and
39+
maintainability of your source code.
4140

4241
How to fix this
4342
==========
4443

45-
When a class is wearing too many (functional) hats, think about
46-
splitting it up:
47-
* Extract class
48-
* Extract subclass
49-
* Extract interface
44+
When a class is wearing too many (functional) hats (too large
45+
classes), you should probably think about splitting it up:
46+
47+
* Extract class
48+
* Extract subclass
49+
* Extract interface
5050

‎Root/Smell/Complexity/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
Complexity
1010
==========
11-
This aspect checks on the cyclomatic complexity of your code
11+
This aspect checks on the cyclomatic complexity of your code.
1212

1313
Tastes
1414
========

‎Root/Smell/MethodSmell/README.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88

99
MethodSmell
1010
===========
11-
This aspect detects `code smells` or `bad smells` related to methods'
12-
and functions definitions in your codebase.
11+
This aspect detects `code smells` related to methods' and functions
12+
definitions in your codebase.
1313

14-
Method-level code smells are simply code smells indicating poorly defined
15-
method and or functions (too long method or functions, or functions with
16-
too many parameters) in your source code.
14+
Method-level code smells indicate poorly defined method and or
15+
functions (too long method or functions, or functions with too many
16+
parameters) in your source code.
1717

1818
Tastes
1919
========
@@ -27,7 +27,7 @@ Tastes
2727
| | | |
2828
+----------------------+-----------------------------------------------------------+-----------------------------------------------------------+
2929
| | | |
30-
|``max_paramters`` | Represents the max number of parameters for a function's. | **10**, 5 +
30+
|``max_parameters`` | Represents the max number of parameters for a function's. | **10**, 5 +
3131
| | | |
3232
+----------------------+-----------------------------------------------------------+-----------------------------------------------------------+
3333

@@ -53,9 +53,9 @@ Example
5353
Importance
5454
==========
5555

56-
Make your functions and methods unambiguous(by reducing the number of
57-
parameters, easy to read(by reducing the length of your methods and
58-
functions) and debug.
56+
Make your functions and methods unambiguous, easy to read and debug
57+
by reducing the number of parameters and length of your methods and
58+
functions.
5959

6060
How to fix this
6161
==========

‎Root/Smell/Naming/README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Naming
1010
======
1111
This aspect checks on identifiers in your codebase (their length
1212
and the appropriate naming convention to use for them, be it variables,
13-
classes or functions)
13+
classes or functions names.)
1414

1515
Tastes
1616
========
@@ -19,11 +19,11 @@ Tastes
1919
| Taste | Meaning | Values |
2020
+===============================+=======================================================+=======================================================+
2121
| | | |
22-
|``class_naming_convention`` | Naming convention to use for classes's identifiers | **UpperCamelCase**, lowerCamelCase, snake_case, hyphenated-case+
22+
|``class_naming_convention`` | Naming convention to use for classes's identifiers | **UpperCamelCase**, lowerCamelCase, snake_case, kebab-case+
2323
| | | |
2424
+-------------------------------+-------------------------------------------------------+-------------------------------------------------------+
2525
| | | |
26-
|``function_naming_convention`` | Naming convention to use for functions's or methods's | **snake_case**, lowerCamelCase, hyphenated-case, UpperCamelcase|
26+
|``function_naming_convention`` | Naming convention to use for functions's or methods's | **snake_case**, lowerCamelCase, kebab-case, UpperCamelcase|
2727
| | identifiers | |
2828
| | | |
2929
+-------------------------------+-------------------------------------------------------+-------------------------------------------------------+
@@ -32,7 +32,7 @@ Tastes
3232
| | | |
3333
+-------------------------------+-------------------------------------------------------+-------------------------------------------------------+
3434
| | | |
35-
|``variable_naming_convention`` | Naming convention to use for variables's identifiers | **snake_case**, lowerCamelCase, hyphenated-case, UpperCamelCase+
35+
|``variable_naming_convention`` | Naming convention to use for variables's identifiers | **snake_case**, lowerCamelCase, kebab-case, UpperCamelCase+
3636
| | | |
3737
+-------------------------------+-------------------------------------------------------+-------------------------------------------------------+
3838

‎Root/Smell/README.rst

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
| ``Root.Smell`` | `Parent <../README.rst>`_ | `Index <//github.com/coala/aspect-docs/blob/master/README.rst>`_ |
33
+----------------+----------------------------+------------------------------------------------------------------+
44

5-
+---------------------+--------------------------------------+------------------------------------------+--------------------------------------+
6-
| **Sibling aspects** | `Metadata <../Metadata/README.rst>`_ | `Redundancy <../Redundancy/README.rst>`_ | `Spelling <../Spelling/README.rst>`_ |
7-
+---------------------+--------------------------------------+------------------------------------------+--------------------------------------+
5+
+---------------------+--------------------------------------+------------------------------------------+--------------------------------------+--------------------------------------+
6+
| **Sibling aspects** | `Metadata <../Metadata/README.rst>`_ | `Redundancy <../Redundancy/README.rst>`_ | `Security <../Security/README.rst>`_ | `Spelling <../Spelling/README.rst>`_ |
7+
+---------------------+--------------------------------------+------------------------------------------+--------------------------------------+--------------------------------------+
88

99
Smell
1010
=====
1111
This aspect detects `code smells` or `bad smells` in your code.
1212

13-
`Smells` are certain structures in the code that indicate violation of
13+
`Smells` are certain structures in a code that indicate violation of
1414
fundamental design principles. They are usually not bugs; they are not
1515
technically incorrect and do not currently prevent the program from
1616
functioning.
@@ -37,11 +37,22 @@ Example
3737
Importance
3838
==========
3939

40-
Even though they are not necessarily bugs, code smells increase the risk
41-
of bugs or failure in the future and may slow down development.
40+
Even though they are not necessarily bugs, code smells increase the
41+
risk of bugs or failure in the future and may slow down development.
4242

4343
How to fix this
4444
==========
4545

46-
some fix suggestions
46+
There are several `refactoring techniques` that can be used to deal
47+
with `code smells` including:
48+
49+
* Composing methods
50+
* Moving features between objects
51+
* Organizing data
52+
* Simplifying conditional expressions
53+
* Simplifying method calls
54+
* Dealing with generalisation
55+
56+
See <https://sourcemaking.com/refactoring/refactorings> for more
57+
information.
4758

‎Root/Spelling/README.rst

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

5-
+---------------------+--------------------------------------+------------------------------------------+--------------------------------+
6-
| **Sibling aspects** | `Metadata <../Metadata/README.rst>`_ | `Redundancy <../Redundancy/README.rst>`_ | `Smell <../Smell/README.rst>`_ |
7-
+---------------------+--------------------------------------+------------------------------------------+--------------------------------+
5+
+---------------------+--------------------------------------+------------------------------------------+--------------------------------------+--------------------------------+
6+
| **Sibling aspects** | `Metadata <../Metadata/README.rst>`_ | `Redundancy <../Redundancy/README.rst>`_ | `Security <../Security/README.rst>`_ | `Smell <../Smell/README.rst>`_ |
7+
+---------------------+--------------------------------------+------------------------------------------+--------------------------------------+--------------------------------+
88

99
Spelling
1010
========

0 commit comments

Comments
 (0)