Skip to content

Commit d847ad0

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

6 files changed

Lines changed: 25 additions & 210 deletions

File tree

.codeboarding/Listing_Streaming.json

Lines changed: 0 additions & 109 deletions
This file was deleted.

.codeboarding/Listing_Streaming.rst

Lines changed: 0 additions & 93 deletions
This file was deleted.

.codeboarding/analysis.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@
158158
"praw/models/listing/mixins/redditor.py",
159159
"praw/models/listing/mixins/rising.py"
160160
],
161-
"can_expand": true
161+
"can_expand": false
162162
},
163163
{
164164
"name": "Unclassified",
@@ -296,6 +296,13 @@
296296
"assigned_files": [],
297297
"can_expand": false
298298
},
299+
{
300+
"name": "Unclassified",
301+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
302+
"referenced_source_code": [],
303+
"assigned_files": [],
304+
"can_expand": false
305+
},
299306
{
300307
"name": "Unclassified",
301308
"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": "6203621c258d40ba3cfaaf68a723fdc2185f2d25",
2+
"commit_hash": "6d5217ecd09b44f06cab364c1dc96a12e4f17a58",
33
"code_boarding_version": "0.2.0"
44
}

.codeboarding/overview.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Overview
2828
Unclassified["Unclassified"]
2929
Unclassified["Unclassified"]
3030
Unclassified["Unclassified"]
31+
Unclassified["Unclassified"]
3132
Reddit_Client -- "loads settings from" --> Configuration_Manager
3233
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
3334
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -41,7 +42,6 @@ Overview
4142
click Low_Level_API_Connector href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Low_Level_API_Connector.html" "Details"
4243
click Object_Transformer href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Object_Transformer.html" "Details"
4344
click Reddit_Data_Models href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Reddit_Data_Models.html" "Details"
44-
click Listing_Streaming href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Listing_Streaming.html" "Details"
4545

4646
| |codeboarding-badge| |demo-badge| |contact-badge|
4747
@@ -115,8 +115,6 @@ A collection of classes representing various Reddit entities (e.g., `Subreddit`,
115115
Listing & Streaming
116116
^^^^^^^^^^^^^^^^^^^
117117

118-
:ref:`Expand <Listing_Streaming>`
119-
120118
Provides mechanisms for efficiently retrieving and iterating over collections of Reddit items, including real-time data streams.
121119

122120
**Related Classes/Methods**:
@@ -248,3 +246,10 @@ Unclassified
248246
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
249247

250248
**Related Classes/Methods**: *None*
249+
250+
Unclassified
251+
^^^^^^^^^^^^
252+
253+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
254+
255+
**Related Classes/Methods**: *None*

docs/architecture_overview/overview.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Overview
2828
Unclassified["Unclassified"]
2929
Unclassified["Unclassified"]
3030
Unclassified["Unclassified"]
31+
Unclassified["Unclassified"]
3132
Reddit_Client -- "loads settings from" --> Configuration_Manager
3233
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
3334
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -41,7 +42,6 @@ Overview
4142
click Low_Level_API_Connector href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Low_Level_API_Connector.html" "Details"
4243
click Object_Transformer href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Object_Transformer.html" "Details"
4344
click Reddit_Data_Models href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Reddit_Data_Models.html" "Details"
44-
click Listing_Streaming href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Listing_Streaming.html" "Details"
4545

4646
| |codeboarding-badge| |demo-badge| |contact-badge|
4747
@@ -115,8 +115,6 @@ A collection of classes representing various Reddit entities (e.g., `Subreddit`,
115115
Listing & Streaming
116116
^^^^^^^^^^^^^^^^^^^
117117

118-
:ref:`Expand <Listing_Streaming>`
119-
120118
Provides mechanisms for efficiently retrieving and iterating over collections of Reddit items, including real-time data streams.
121119

122120
**Related Classes/Methods**:
@@ -248,3 +246,10 @@ Unclassified
248246
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
249247

250248
**Related Classes/Methods**: *None*
249+
250+
Unclassified
251+
^^^^^^^^^^^^
252+
253+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
254+
255+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)