Skip to content

Commit dfc529d

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 aaf35ed commit dfc529d

4 files changed

Lines changed: 31 additions & 8 deletions

File tree

.codeboarding/analysis.json

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313
}
1414
],
1515
"assigned_files": [
16-
"praw/reddit.py"
16+
"praw/reddit.py",
17+
"praw/endpoints.py",
18+
"praw/models/auth.py"
1719
],
1820
"can_expand": true
1921
},
@@ -31,7 +33,7 @@
3133
"assigned_files": [
3234
"praw/config.py"
3335
],
34-
"can_expand": true
36+
"can_expand": false
3537
},
3638
{
3739
"name": "Low-Level API Connector",
@@ -78,7 +80,6 @@
7880
"praw/models/__init__.py",
7981
"praw/models/mod_note.py",
8082
"praw/models/base.py",
81-
"praw/models/util.py",
8283
"praw/models/front.py",
8384
"praw/models/preferences.py",
8485
"praw/models/redditors.py",
@@ -87,11 +88,9 @@
8788
"praw/models/comment_forest.py",
8889
"praw/models/mod_notes.py",
8990
"praw/models/trophy.py",
90-
"praw/models/helpers.py",
9191
"praw/models/inbox.py",
9292
"praw/models/subreddits.py",
9393
"praw/models/stylesheet.py",
94-
"praw/models/auth.py",
9594
"praw/models/list/moderated.py",
9695
"praw/models/list/__init__.py",
9796
"praw/models/list/base.py",
@@ -176,11 +175,12 @@
176175
"docs/examples/lmgtfy_bot.py",
177176
"praw/__init__.py",
178177
"praw/const.py",
179-
"praw/endpoints.py",
180178
"praw/exceptions.py",
181179
"praw/util/__init__.py",
182180
"praw/util/cache.py",
183-
"praw/util/snake.py"
181+
"praw/util/snake.py",
182+
"praw/models/util.py",
183+
"praw/models/helpers.py"
184184
],
185185
"can_expand": false
186186
},
@@ -191,6 +191,13 @@
191191
"assigned_files": [],
192192
"can_expand": false
193193
},
194+
{
195+
"name": "Unclassified",
196+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
197+
"referenced_source_code": [],
198+
"assigned_files": [],
199+
"can_expand": false
200+
},
194201
{
195202
"name": "Unclassified",
196203
"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": "090164fb6f365f6fd83ea6ad67fe82d29e1df408",
2+
"commit_hash": "aaf35edac5be1fffe97c8a1922de702ecbef288c",
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
@@ -13,6 +13,7 @@ Overview
1313
Unclassified["Unclassified"]
1414
Unclassified["Unclassified"]
1515
Unclassified["Unclassified"]
16+
Unclassified["Unclassified"]
1617
Reddit_Client -- "loads settings from" --> Configuration_Manager
1718
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
1819
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -125,3 +126,10 @@ Unclassified
125126
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
126127

127128
**Related Classes/Methods**: *None*
129+
130+
Unclassified
131+
^^^^^^^^^^^^
132+
133+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
134+
135+
**Related Classes/Methods**: *None*

docs/architecture_overview/overview.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Overview
1313
Unclassified["Unclassified"]
1414
Unclassified["Unclassified"]
1515
Unclassified["Unclassified"]
16+
Unclassified["Unclassified"]
1617
Reddit_Client -- "loads settings from" --> Configuration_Manager
1718
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
1819
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -125,3 +126,10 @@ Unclassified
125126
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
126127

127128
**Related Classes/Methods**: *None*
129+
130+
Unclassified
131+
^^^^^^^^^^^^
132+
133+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
134+
135+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)