Skip to content

Commit 0826790

Browse files
docs: format and include test metrics (#4)
1 parent b401e1a commit 0826790

File tree

1 file changed

+36
-16
lines changed

1 file changed

+36
-16
lines changed

courseProjectDocs/project-proposal.md

Lines changed: 36 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,39 @@
33

44
## Project Overview
55

6-
This repository is a curated collection of algorithmic implementations in Python, designed to serve as a reference, learning resource, and toolkit for developers and students alike. It spans a wide range of domains, including blockchain, ciphers, data compressions, data structures, linear algebra, etc.
7-
6+
[TheAlgorithms/Python](https://github.com/TheAlgorithms/Python) is an open-source repository for learning, practicing, and understanding algorithms in Python. It offers a curated collection of algorithm implementations that serve as a reference, educational resource, and practical toolkit for both students and developers. It covers a wide range of domains, including blockchain, cryptography, data compression, data structures, linear algebra, and more.
87

98
## Key Quality Metrics
109

10+
For the purpose of this assignment, we will be diving into the **[Data Dtructures](https://github.com/SWEN-777/TheAlgorithms-Python/tree/master/data_structures)** directory to evaluate its key quality metrics.
1111

1212
### Code Structure
1313

1414
#### Lines of Code
1515

1616
Data Structures Directory:
1717

18-
1. arrays: 871
19-
2. binary tree: 4992
20-
3. disjoint set: 129
21-
4. hashing: 881
22-
5. heap: 1310
23-
6. kd tree: 275
24-
7. linked list: 2611
25-
8. queues: 1246
26-
9. stacks: 1321
27-
10. suffix tree: 165
28-
11. trie: 289
29-
- #### total: 14090
18+
| Section | Count |
19+
|---------------|-------|
20+
| Arrays | 871 |
21+
| Binary Tree | 4992 |
22+
| Disjoint Set | 129 |
23+
| Hashing | 881 |
24+
| Heap | 0 |
25+
| KD Tree | 275 |
26+
| Linked List | 2611 |
27+
| Queues | 1246 |
28+
| Stacks | 1321 |
29+
| Suffix Tree | 165 |
30+
| Trie | 289 |
31+
| **Total** | **14090** |
3032

3133
#### Comment Density
3234

33-
< include metrics here >
35+
Comment lines: 7160
36+
Comment density: 50.82%
37+
38+
> Note: Refer to comment density code [here](https://github.com/SWEN-777/TheAlgorithms-Python/blob/master/courseProjectCode/metrics/comment_density.py)
3439
3540
#### Cyclomatic Complexity
3641

@@ -40,7 +45,22 @@ Data Structures Directory:
4045

4146
#### Number of Unit Test Cases
4247

43-
< include metrics here >
48+
While many examples are provided for the data structure algorithms, the following reflects the number of proper unit tests available in each section:
49+
50+
| Section | Unit Tests |
51+
|---------------|------------|
52+
| Arrays | 1 |
53+
| Binary Tree | 21 |
54+
| Disjoint Set | 1 |
55+
| Hashing | 2 |
56+
| Heap | 0 |
57+
| KD Tree | 3 |
58+
| Linked List | 13 |
59+
| Queues | 0 |
60+
| Stacks | 1 |
61+
| Suffix Tree | 5 |
62+
| Trie | 2 |
63+
| **Total** | **49** |
4464

4565
#### Test Coverage
4666

0 commit comments

Comments
 (0)