Skip to content

Commit c595221

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 ea80ca6 commit c595221

File tree

4 files changed

+26
-3
lines changed

4 files changed

+26
-3
lines changed

.codeboarding/analysis.json

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313
}
1414
],
1515
"assigned_files": [
16-
"praw/reddit.py"
16+
"praw/reddit.py",
17+
"praw/endpoints.py"
1718
],
1819
"can_expand": true
1920
},
@@ -176,7 +177,6 @@
176177
"docs/examples/lmgtfy_bot.py",
177178
"praw/__init__.py",
178179
"praw/const.py",
179-
"praw/endpoints.py",
180180
"praw/exceptions.py",
181181
"praw/util/__init__.py",
182182
"praw/util/cache.py",
@@ -212,6 +212,13 @@
212212
"assigned_files": [],
213213
"can_expand": false
214214
},
215+
{
216+
"name": "Unclassified",
217+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
218+
"referenced_source_code": [],
219+
"assigned_files": [],
220+
"can_expand": false
221+
},
215222
{
216223
"name": "Unclassified",
217224
"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": "38807c47c93eb29b7c540e44196a7adf38433464",
2+
"commit_hash": "ea80ca676fe8ba004e01e2c2cd3b178110006f2f",
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
@@ -16,6 +16,7 @@ Overview
1616
Unclassified["Unclassified"]
1717
Unclassified["Unclassified"]
1818
Unclassified["Unclassified"]
19+
Unclassified["Unclassified"]
1920
Reddit_Client -- "loads settings from" --> Configuration_Manager
2021
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
2122
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -152,3 +153,10 @@ Unclassified
152153
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
153154

154155
**Related Classes/Methods**: *None*
156+
157+
Unclassified
158+
^^^^^^^^^^^^
159+
160+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
161+
162+
**Related Classes/Methods**: *None*

docs/architecture_overview/overview.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Overview
1616
Unclassified["Unclassified"]
1717
Unclassified["Unclassified"]
1818
Unclassified["Unclassified"]
19+
Unclassified["Unclassified"]
1920
Reddit_Client -- "loads settings from" --> Configuration_Manager
2021
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
2122
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -152,3 +153,10 @@ Unclassified
152153
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
153154

154155
**Related Classes/Methods**: *None*
156+
157+
Unclassified
158+
^^^^^^^^^^^^
159+
160+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
161+
162+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)