Skip to content

Commit 5e68936

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 48b710e commit 5e68936

5 files changed

Lines changed: 42 additions & 52 deletions

File tree

.codeboarding/Listing_Streaming.json

Lines changed: 7 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,7 @@
1111
"reference_start_line": 17,
1212
"reference_end_line": 103
1313
}
14-
],
15-
"assigned_files": [
16-
"praw/models/listing/generator.py"
17-
],
18-
"can_expand": true
14+
]
1915
},
2016
{
2117
"name": "StreamGenerator",
@@ -27,9 +23,7 @@
2723
"reference_start_line": 1,
2824
"reference_end_line": 10
2925
}
30-
],
31-
"assigned_files": [],
32-
"can_expand": true
26+
]
3327
},
3428
{
3529
"name": "BaseListingMixin",
@@ -41,11 +35,7 @@
4135
"reference_start_line": 15,
4236
"reference_end_line": 149
4337
}
44-
],
45-
"assigned_files": [
46-
"praw/models/listing/mixins/base.py"
47-
],
48-
"can_expand": true
38+
]
4939
},
5040
{
5141
"name": "praw.Reddit",
@@ -57,9 +47,7 @@
5747
"reference_start_line": 57,
5848
"reference_end_line": 600
5949
}
60-
],
61-
"assigned_files": [],
62-
"can_expand": true
50+
]
6351
},
6452
{
6553
"name": "praw.models",
@@ -71,24 +59,7 @@
7159
"reference_start_line": null,
7260
"reference_end_line": null
7361
}
74-
],
75-
"assigned_files": [
76-
"praw/models/list/moderated.py",
77-
"praw/models/list/__init__.py",
78-
"praw/models/list/base.py",
79-
"praw/models/list/draft.py",
80-
"praw/models/list/redditor.py",
81-
"praw/models/list/trophy.py",
82-
"praw/models/listing/__init__.py",
83-
"praw/models/listing/domain.py",
84-
"praw/models/listing/listing.py",
85-
"praw/models/listing/mixins/__init__.py",
86-
"praw/models/listing/mixins/submission.py",
87-
"praw/models/listing/mixins/subreddit.py",
88-
"praw/models/listing/mixins/redditor.py",
89-
"praw/models/listing/mixins/rising.py"
90-
],
91-
"can_expand": true
62+
]
9263
},
9364
{
9465
"name": "prawcore",
@@ -100,16 +71,12 @@
10071
"reference_start_line": 527,
10172
"reference_end_line": 546
10273
}
103-
],
104-
"assigned_files": [],
105-
"can_expand": true
74+
]
10675
},
10776
{
10877
"name": "Unclassified",
10978
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
110-
"referenced_source_code": [],
111-
"assigned_files": [],
112-
"can_expand": false
79+
"referenced_source_code": []
11380
}
11481
],
11582
"components_relations": [

.codeboarding/analysis.json

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
],
1515
"assigned_files": [
1616
"praw/reddit.py",
17-
"praw/endpoints.py"
17+
"praw/endpoints.py",
18+
"praw/models/auth.py"
1819
],
1920
"can_expand": true
2021
},
@@ -76,10 +77,8 @@
7677
}
7778
],
7879
"assigned_files": [
79-
"praw/models/__init__.py",
8080
"praw/models/mod_note.py",
8181
"praw/models/base.py",
82-
"praw/models/util.py",
8382
"praw/models/front.py",
8483
"praw/models/preferences.py",
8584
"praw/models/redditors.py",
@@ -88,12 +87,9 @@
8887
"praw/models/comment_forest.py",
8988
"praw/models/mod_notes.py",
9089
"praw/models/trophy.py",
91-
"praw/models/helpers.py",
9290
"praw/models/inbox.py",
9391
"praw/models/subreddits.py",
9492
"praw/models/stylesheet.py",
95-
"praw/models/auth.py",
96-
"praw/models/reddit/__init__.py",
9793
"praw/models/reddit/submission.py",
9894
"praw/models/reddit/widgets.py",
9995
"praw/models/reddit/base.py",
@@ -114,7 +110,6 @@
114110
"praw/models/reddit/message.py",
115111
"praw/models/reddit/inline_media.py",
116112
"praw/models/reddit/wikipage.py",
117-
"praw/models/reddit/mixins/__init__.py",
118113
"praw/models/reddit/mixins/inboxtoggleable.py",
119114
"praw/models/reddit/mixins/inboxable.py",
120115
"praw/models/reddit/mixins/savable.py",
@@ -141,16 +136,13 @@
141136
],
142137
"assigned_files": [
143138
"praw/models/list/moderated.py",
144-
"praw/models/list/__init__.py",
145139
"praw/models/list/base.py",
146140
"praw/models/list/draft.py",
147141
"praw/models/list/redditor.py",
148142
"praw/models/list/trophy.py",
149-
"praw/models/listing/__init__.py",
150143
"praw/models/listing/domain.py",
151144
"praw/models/listing/listing.py",
152145
"praw/models/listing/generator.py",
153-
"praw/models/listing/mixins/__init__.py",
154146
"praw/models/listing/mixins/submission.py",
155147
"praw/models/listing/mixins/base.py",
156148
"praw/models/listing/mixins/subreddit.py",
@@ -180,7 +172,15 @@
180172
"praw/exceptions.py",
181173
"praw/util/__init__.py",
182174
"praw/util/cache.py",
183-
"praw/util/snake.py"
175+
"praw/util/snake.py",
176+
"praw/models/__init__.py",
177+
"praw/models/util.py",
178+
"praw/models/helpers.py",
179+
"praw/models/list/__init__.py",
180+
"praw/models/listing/__init__.py",
181+
"praw/models/listing/mixins/__init__.py",
182+
"praw/models/reddit/__init__.py",
183+
"praw/models/reddit/mixins/__init__.py"
184184
],
185185
"can_expand": false
186186
},
@@ -310,6 +310,13 @@
310310
"assigned_files": [],
311311
"can_expand": false
312312
},
313+
{
314+
"name": "Unclassified",
315+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
316+
"referenced_source_code": [],
317+
"assigned_files": [],
318+
"can_expand": false
319+
},
313320
{
314321
"name": "Unclassified",
315322
"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": "d847ad04a9d13b08f89131b420b922dbf5bce6f7",
2+
"commit_hash": "48b710e20867edadb66a8763254e28b2a55747d8",
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
@@ -30,6 +30,7 @@ Overview
3030
Unclassified["Unclassified"]
3131
Unclassified["Unclassified"]
3232
Unclassified["Unclassified"]
33+
Unclassified["Unclassified"]
3334
Reddit_Client -- "loads settings from" --> Configuration_Manager
3435
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
3536
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -261,3 +262,10 @@ Unclassified
261262
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
262263

263264
**Related Classes/Methods**: *None*
265+
266+
Unclassified
267+
^^^^^^^^^^^^
268+
269+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
270+
271+
**Related Classes/Methods**: *None*

docs/architecture_overview/overview.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Overview
3030
Unclassified["Unclassified"]
3131
Unclassified["Unclassified"]
3232
Unclassified["Unclassified"]
33+
Unclassified["Unclassified"]
3334
Reddit_Client -- "loads settings from" --> Configuration_Manager
3435
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
3536
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -261,3 +262,10 @@ Unclassified
261262
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
262263

263264
**Related Classes/Methods**: *None*
265+
266+
Unclassified
267+
^^^^^^^^^^^^
268+
269+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
270+
271+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)