Skip to content

Commit 6d5217e

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 6203621 commit 6d5217e

6 files changed

Lines changed: 42 additions & 56 deletions

File tree

.codeboarding/Configuration_Manager.json

Lines changed: 4 additions & 14 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": "praw.Reddit",
@@ -27,9 +23,7 @@
2723
"reference_start_line": 57,
2824
"reference_end_line": 901
2925
}
30-
],
31-
"assigned_files": [],
32-
"can_expand": true
26+
]
3327
},
3428
{
3529
"name": "prawcore",
@@ -41,16 +35,12 @@
4135
"reference_start_line": 527,
4236
"reference_end_line": 546
4337
}
44-
],
45-
"assigned_files": [],
46-
"can_expand": true
38+
]
4739
},
4840
{
4941
"name": "Unclassified",
5042
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
51-
"referenced_source_code": [],
52-
"assigned_files": [],
53-
"can_expand": false
43+
"referenced_source_code": []
5444
}
5545
],
5646
"components_relations": [

.codeboarding/Listing_Streaming.json

Lines changed: 7 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,7 @@
1111
"reference_start_line": 15,
1212
"reference_end_line": 149
1313
}
14-
],
15-
"assigned_files": [
16-
"praw/models/listing/mixins/__init__.py",
17-
"praw/models/listing/mixins/submission.py",
18-
"praw/models/listing/mixins/base.py",
19-
"praw/models/listing/mixins/subreddit.py",
20-
"praw/models/listing/mixins/redditor.py",
21-
"praw/models/listing/mixins/rising.py"
22-
],
23-
"can_expand": false
14+
]
2415
},
2516
{
2617
"name": "Listing Generator",
@@ -32,11 +23,7 @@
3223
"reference_start_line": 17,
3324
"reference_end_line": 103
3425
}
35-
],
36-
"assigned_files": [
37-
"praw/models/listing/generator.py"
38-
],
39-
"can_expand": true
26+
]
4027
},
4128
{
4229
"name": "Listing Base",
@@ -48,13 +35,7 @@
4835
"reference_start_line": 13,
4936
"reference_end_line": 34
5037
}
51-
],
52-
"assigned_files": [
53-
"praw/models/listing/__init__.py",
54-
"praw/models/listing/domain.py",
55-
"praw/models/listing/listing.py"
56-
],
57-
"can_expand": false
38+
]
5839
},
5940
{
6041
"name": "Stream Handlers",
@@ -66,9 +47,7 @@
6647
"reference_start_line": null,
6748
"reference_end_line": null
6849
}
69-
],
70-
"assigned_files": [],
71-
"can_expand": true
50+
]
7251
},
7352
{
7453
"name": "Reddit Client Interface",
@@ -80,9 +59,7 @@
8059
"reference_start_line": null,
8160
"reference_end_line": null
8261
}
83-
],
84-
"assigned_files": [],
85-
"can_expand": false
62+
]
8663
},
8764
{
8865
"name": "Data Model Integration",
@@ -94,16 +71,12 @@
9471
"reference_start_line": null,
9572
"reference_end_line": null
9673
}
97-
],
98-
"assigned_files": [],
99-
"can_expand": true
74+
]
10075
},
10176
{
10277
"name": "Unclassified",
10378
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
104-
"referenced_source_code": [],
105-
"assigned_files": [],
106-
"can_expand": false
79+
"referenced_source_code": []
10780
}
10881
],
10982
"components_relations": [

.codeboarding/analysis.json

Lines changed: 14 additions & 7 deletions
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
],
@@ -93,12 +94,6 @@
9394
"praw/models/subreddits.py",
9495
"praw/models/stylesheet.py",
9596
"praw/models/auth.py",
96-
"praw/models/list/moderated.py",
97-
"praw/models/list/__init__.py",
98-
"praw/models/list/base.py",
99-
"praw/models/list/draft.py",
100-
"praw/models/list/redditor.py",
101-
"praw/models/list/trophy.py",
10297
"praw/models/reddit/__init__.py",
10398
"praw/models/reddit/submission.py",
10499
"praw/models/reddit/widgets.py",
@@ -146,6 +141,12 @@
146141
}
147142
],
148143
"assigned_files": [
144+
"praw/models/list/moderated.py",
145+
"praw/models/list/__init__.py",
146+
"praw/models/list/base.py",
147+
"praw/models/list/draft.py",
148+
"praw/models/list/redditor.py",
149+
"praw/models/list/trophy.py",
149150
"praw/models/listing/__init__.py",
150151
"praw/models/listing/domain.py",
151152
"praw/models/listing/listing.py",
@@ -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",
@@ -289,6 +289,13 @@
289289
"assigned_files": [],
290290
"can_expand": false
291291
},
292+
{
293+
"name": "Unclassified",
294+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
295+
"referenced_source_code": [],
296+
"assigned_files": [],
297+
"can_expand": false
298+
},
292299
{
293300
"name": "Unclassified",
294301
"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": "40ee417c82f225530f452c38a97f8c45f4e25e2d",
2+
"commit_hash": "6203621c258d40ba3cfaaf68a723fdc2185f2d25",
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
@@ -27,6 +27,7 @@ Overview
2727
Unclassified["Unclassified"]
2828
Unclassified["Unclassified"]
2929
Unclassified["Unclassified"]
30+
Unclassified["Unclassified"]
3031
Reddit_Client -- "loads settings from" --> Configuration_Manager
3132
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
3233
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -240,3 +241,10 @@ Unclassified
240241
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
241242

242243
**Related Classes/Methods**: *None*
244+
245+
Unclassified
246+
^^^^^^^^^^^^
247+
248+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
249+
250+
**Related Classes/Methods**: *None*

docs/architecture_overview/overview.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Overview
2727
Unclassified["Unclassified"]
2828
Unclassified["Unclassified"]
2929
Unclassified["Unclassified"]
30+
Unclassified["Unclassified"]
3031
Reddit_Client -- "loads settings from" --> Configuration_Manager
3132
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
3233
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -240,3 +241,10 @@ Unclassified
240241
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
241242

242243
**Related Classes/Methods**: *None*
244+
245+
Unclassified
246+
^^^^^^^^^^^^
247+
248+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
249+
250+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)