Skip to content

Commit 40ee417

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: 5 - JSON files created/updated: 6 - 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 b9a7b67 commit 40ee417

6 files changed

Lines changed: 27 additions & 143 deletions

File tree

.codeboarding/Listing_Streaming.json

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

.codeboarding/Listing_Streaming.rst

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

.codeboarding/analysis.json

Lines changed: 10 additions & 3 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
},
@@ -157,7 +156,7 @@
157156
"praw/models/listing/mixins/redditor.py",
158157
"praw/models/listing/mixins/rising.py"
159158
],
160-
"can_expand": true
159+
"can_expand": false
161160
},
162161
{
163162
"name": "Unclassified",
@@ -177,6 +176,7 @@
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",
@@ -275,6 +275,13 @@
275275
"assigned_files": [],
276276
"can_expand": false
277277
},
278+
{
279+
"name": "Unclassified",
280+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
281+
"referenced_source_code": [],
282+
"assigned_files": [],
283+
"can_expand": false
284+
},
278285
{
279286
"name": "Unclassified",
280287
"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": "59f28329e75d0e8aeec6a0ce8b3a3f0763fbad15",
2+
"commit_hash": "b9a7b672f267291545865006836888348991c48a",
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
@@ -25,6 +25,7 @@ Overview
2525
Unclassified["Unclassified"]
2626
Unclassified["Unclassified"]
2727
Unclassified["Unclassified"]
28+
Unclassified["Unclassified"]
2829
Reddit_Client -- "loads settings from" --> Configuration_Manager
2930
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
3031
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -37,7 +38,6 @@ Overview
3738
click Low_Level_API_Connector href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Low_Level_API_Connector.html" "Details"
3839
click Object_Transformer href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Object_Transformer.html" "Details"
3940
click Reddit_Data_Models href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Reddit_Data_Models.html" "Details"
40-
click Listing_Streaming href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Listing_Streaming.html" "Details"
4141

4242
| |codeboarding-badge| |demo-badge| |contact-badge|
4343
@@ -109,8 +109,6 @@ A collection of classes representing various Reddit entities (e.g., `Subreddit`,
109109
Listing & Streaming
110110
^^^^^^^^^^^^^^^^^^^
111111

112-
:ref:`Expand <Listing_Streaming>`
113-
114112
Provides mechanisms for efficiently retrieving and iterating over collections of Reddit items, including real-time data streams.
115113

116114
**Related Classes/Methods**:
@@ -221,3 +219,10 @@ Unclassified
221219
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
222220

223221
**Related Classes/Methods**: *None*
222+
223+
Unclassified
224+
^^^^^^^^^^^^
225+
226+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
227+
228+
**Related Classes/Methods**: *None*

docs/architecture_overview/overview.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Overview
2525
Unclassified["Unclassified"]
2626
Unclassified["Unclassified"]
2727
Unclassified["Unclassified"]
28+
Unclassified["Unclassified"]
2829
Reddit_Client -- "loads settings from" --> Configuration_Manager
2930
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
3031
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -37,7 +38,6 @@ Overview
3738
click Low_Level_API_Connector href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Low_Level_API_Connector.html" "Details"
3839
click Object_Transformer href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Object_Transformer.html" "Details"
3940
click Reddit_Data_Models href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Reddit_Data_Models.html" "Details"
40-
click Listing_Streaming href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Listing_Streaming.html" "Details"
4141

4242
| |codeboarding-badge| |demo-badge| |contact-badge|
4343
@@ -109,8 +109,6 @@ A collection of classes representing various Reddit entities (e.g., `Subreddit`,
109109
Listing & Streaming
110110
^^^^^^^^^^^^^^^^^^^
111111

112-
:ref:`Expand <Listing_Streaming>`
113-
114112
Provides mechanisms for efficiently retrieving and iterating over collections of Reddit items, including real-time data streams.
115113

116114
**Related Classes/Methods**:
@@ -221,3 +219,10 @@ Unclassified
221219
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
222220

223221
**Related Classes/Methods**: *None*
222+
223+
Unclassified
224+
^^^^^^^^^^^^
225+
226+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
227+
228+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)