Skip to content

Commit aaf35ed

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: 6 - JSON files created/updated: 7 - 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 090164f commit aaf35ed

4 files changed

Lines changed: 33 additions & 10 deletions

File tree

.codeboarding/analysis.json

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@
1313
}
1414
],
1515
"assigned_files": [
16-
"praw/reddit.py",
17-
"praw/endpoints.py"
16+
"praw/reddit.py"
1817
],
1918
"can_expand": true
2019
},
@@ -32,7 +31,7 @@
3231
"assigned_files": [
3332
"praw/config.py"
3433
],
35-
"can_expand": false
34+
"can_expand": true
3635
},
3736
{
3837
"name": "Low-Level API Connector",
@@ -93,6 +92,12 @@
9392
"praw/models/subreddits.py",
9493
"praw/models/stylesheet.py",
9594
"praw/models/auth.py",
95+
"praw/models/list/moderated.py",
96+
"praw/models/list/__init__.py",
97+
"praw/models/list/base.py",
98+
"praw/models/list/draft.py",
99+
"praw/models/list/redditor.py",
100+
"praw/models/list/trophy.py",
96101
"praw/models/reddit/__init__.py",
97102
"praw/models/reddit/submission.py",
98103
"praw/models/reddit/widgets.py",
@@ -140,12 +145,6 @@
140145
}
141146
],
142147
"assigned_files": [
143-
"praw/models/list/moderated.py",
144-
"praw/models/list/__init__.py",
145-
"praw/models/list/base.py",
146-
"praw/models/list/draft.py",
147-
"praw/models/list/redditor.py",
148-
"praw/models/list/trophy.py",
149148
"praw/models/listing/__init__.py",
150149
"praw/models/listing/domain.py",
151150
"praw/models/listing/listing.py",
@@ -177,13 +176,21 @@
177176
"docs/examples/lmgtfy_bot.py",
178177
"praw/__init__.py",
179178
"praw/const.py",
179+
"praw/endpoints.py",
180180
"praw/exceptions.py",
181181
"praw/util/__init__.py",
182182
"praw/util/cache.py",
183183
"praw/util/snake.py"
184184
],
185185
"can_expand": false
186186
},
187+
{
188+
"name": "Unclassified",
189+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
190+
"referenced_source_code": [],
191+
"assigned_files": [],
192+
"can_expand": false
193+
},
187194
{
188195
"name": "Unclassified",
189196
"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": "de461083353c3e41a64f14ec289d02396f18db39",
2+
"commit_hash": "090164fb6f365f6fd83ea6ad67fe82d29e1df408",
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
@@ -12,6 +12,7 @@ Overview
1212
Listing_Streaming["Listing & Streaming"]
1313
Unclassified["Unclassified"]
1414
Unclassified["Unclassified"]
15+
Unclassified["Unclassified"]
1516
Reddit_Client -- "loads settings from" --> Configuration_Manager
1617
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
1718
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -117,3 +118,10 @@ Unclassified
117118
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
118119

119120
**Related Classes/Methods**: *None*
121+
122+
Unclassified
123+
^^^^^^^^^^^^
124+
125+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
126+
127+
**Related Classes/Methods**: *None*

docs/architecture_overview/overview.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Overview
1212
Listing_Streaming["Listing & Streaming"]
1313
Unclassified["Unclassified"]
1414
Unclassified["Unclassified"]
15+
Unclassified["Unclassified"]
1516
Reddit_Client -- "loads settings from" --> Configuration_Manager
1617
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
1718
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -117,3 +118,10 @@ Unclassified
117118
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
118119

119120
**Related Classes/Methods**: *None*
121+
122+
Unclassified
123+
^^^^^^^^^^^^
124+
125+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
126+
127+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)