Skip to content

Commit 0f03bf8

Browse files
committed
docs: update codeboarding documentation
## 📚 Documentation Update This commit contains updated documentation files fetched from the CodeBoarding service. ### 📊 Summary - Documentation files created/updated: 7 - JSON files created/updated: 8 - Documentation directory: .codeboarding/ - JSON directory: .codeboarding/ - Output format: .rst - Repository analyzed: https://github.com/CodeBoarding/praw - Source branch: main - Target branch: main 🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
1 parent dedeb36 commit 0f03bf8

5 files changed

Lines changed: 33 additions & 28 deletions

File tree

.codeboarding/Configuration_Manager.json

Lines changed: 8 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,7 @@
1111
"reference_start_line": 52,
1212
"reference_end_line": 52
1313
}
14-
],
15-
"assigned_files": [
16-
"praw/config.py"
17-
],
18-
"can_expand": true
14+
]
1915
},
2016
{
2117
"name": "os module",
@@ -27,9 +23,7 @@
2723
"reference_start_line": null,
2824
"reference_end_line": null
2925
}
30-
],
31-
"assigned_files": [],
32-
"can_expand": false
26+
]
3327
},
3428
{
3529
"name": "configparser module",
@@ -41,9 +35,7 @@
4135
"reference_start_line": null,
4236
"reference_end_line": null
4337
}
44-
],
45-
"assigned_files": [],
46-
"can_expand": false
38+
]
4739
},
4840
{
4941
"name": "importlib.resources",
@@ -55,9 +47,7 @@
5547
"reference_start_line": null,
5648
"reference_end_line": null
5749
}
58-
],
59-
"assigned_files": [],
60-
"can_expand": false
50+
]
6151
},
6252
{
6353
"name": "pathlib.Path",
@@ -69,9 +59,7 @@
6959
"reference_start_line": 10,
7060
"reference_end_line": 20
7161
}
72-
],
73-
"assigned_files": [],
74-
"can_expand": false
62+
]
7563
},
7664
{
7765
"name": "praw.Reddit",
@@ -83,9 +71,7 @@
8371
"reference_start_line": null,
8472
"reference_end_line": null
8573
}
86-
],
87-
"assigned_files": [],
88-
"can_expand": true
74+
]
8975
},
9076
{
9177
"name": "prawcore",
@@ -97,16 +83,12 @@
9783
"reference_start_line": 527,
9884
"reference_end_line": 546
9985
}
100-
],
101-
"assigned_files": [],
102-
"can_expand": true
86+
]
10387
},
10488
{
10589
"name": "Unclassified",
10690
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
107-
"referenced_source_code": [],
108-
"assigned_files": [],
109-
"can_expand": false
91+
"referenced_source_code": []
11092
}
11193
],
11294
"components_relations": [

.codeboarding/analysis.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
}
1414
],
1515
"assigned_files": [
16+
"praw/__init__.py",
1617
"praw/reddit.py",
1718
"praw/endpoints.py"
1819
],
@@ -175,7 +176,6 @@
175176
"docs/conf.py",
176177
"docs/examples/obtain_refresh_token.py",
177178
"docs/examples/lmgtfy_bot.py",
178-
"praw/__init__.py",
179179
"praw/const.py",
180180
"praw/exceptions.py",
181181
"praw/util/__init__.py",
@@ -247,6 +247,13 @@
247247
"assigned_files": [],
248248
"can_expand": false
249249
},
250+
{
251+
"name": "Unclassified",
252+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
253+
"referenced_source_code": [],
254+
"assigned_files": [],
255+
"can_expand": false
256+
},
250257
{
251258
"name": "Unclassified",
252259
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"commit_hash": "79f0c7f66b0c61ed2e6ef14a14deee532f24bca2",
2+
"commit_hash": "dedeb36b072585ea7f9b2bb27c4a9ed87b53361d",
33
"code_boarding_version": "0.2.0"
44
}

.codeboarding/overview.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Overview
2121
Unclassified["Unclassified"]
2222
Unclassified["Unclassified"]
2323
Unclassified["Unclassified"]
24+
Unclassified["Unclassified"]
2425
Reddit_Client -- "loads settings from" --> Configuration_Manager
2526
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
2627
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -192,3 +193,10 @@ Unclassified
192193
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
193194

194195
**Related Classes/Methods**: *None*
196+
197+
Unclassified
198+
^^^^^^^^^^^^
199+
200+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
201+
202+
**Related Classes/Methods**: *None*

docs/architecture_overview/overview.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Overview
2121
Unclassified["Unclassified"]
2222
Unclassified["Unclassified"]
2323
Unclassified["Unclassified"]
24+
Unclassified["Unclassified"]
2425
Reddit_Client -- "loads settings from" --> Configuration_Manager
2526
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
2627
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -192,3 +193,10 @@ Unclassified
192193
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
193194

194195
**Related Classes/Methods**: *None*
196+
197+
Unclassified
198+
^^^^^^^^^^^^
199+
200+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
201+
202+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)