Skip to content

Commit 79f0c7f

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 49af8aa commit 79f0c7f

6 files changed

Lines changed: 27 additions & 180 deletions

File tree

.codeboarding/Configuration_Manager.json

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

.codeboarding/Configuration_Manager.rst

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

.codeboarding/analysis.json

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
"assigned_files": [
1616
"praw/__init__.py",
1717
"praw/reddit.py",
18-
"praw/endpoints.py"
18+
"praw/endpoints.py",
19+
"praw/models/auth.py"
1920
],
2021
"can_expand": true
2122
},
@@ -33,7 +34,7 @@
3334
"assigned_files": [
3435
"praw/config.py"
3536
],
36-
"can_expand": true
37+
"can_expand": false
3738
},
3839
{
3940
"name": "Low-Level API Connector",
@@ -93,7 +94,6 @@
9394
"praw/models/inbox.py",
9495
"praw/models/subreddits.py",
9596
"praw/models/stylesheet.py",
96-
"praw/models/auth.py",
9797
"praw/models/reddit/__init__.py",
9898
"praw/models/reddit/submission.py",
9999
"praw/models/reddit/widgets.py",
@@ -233,6 +233,13 @@
233233
"assigned_files": [],
234234
"can_expand": false
235235
},
236+
{
237+
"name": "Unclassified",
238+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
239+
"referenced_source_code": [],
240+
"assigned_files": [],
241+
"can_expand": false
242+
},
236243
{
237244
"name": "Unclassified",
238245
"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": "a0d46f08a35124e3e7220fdcd3dc1f4654cca016",
2+
"commit_hash": "49af8aac73afaec39a23634d326054bceb3e4075",
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
@@ -19,6 +19,7 @@ Overview
1919
Unclassified["Unclassified"]
2020
Unclassified["Unclassified"]
2121
Unclassified["Unclassified"]
22+
Unclassified["Unclassified"]
2223
Reddit_Client -- "loads settings from" --> Configuration_Manager
2324
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
2425
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -28,7 +29,6 @@ Overview
2829
Listing_Streaming -- "fetches data via" --> Reddit_Client
2930
Listing_Streaming -- "generates" --> Reddit_Data_Models
3031
click Reddit_Client href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Reddit_Client.html" "Details"
31-
click Configuration_Manager href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Configuration_Manager.html" "Details"
3232
click Low_Level_API_Connector href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Low_Level_API_Connector.html" "Details"
3333
click Object_Transformer href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Object_Transformer.html" "Details"
3434
click Reddit_Data_Models href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Reddit_Data_Models.html" "Details"
@@ -62,8 +62,6 @@ The primary interface for interacting with the Reddit API, managing authenticati
6262
Configuration Manager
6363
^^^^^^^^^^^^^^^^^^^^^
6464

65-
:ref:`Expand <Configuration_Manager>`
66-
6765
Manages loading and accessing PRAW's configuration settings.
6866

6967
**Related Classes/Methods**:
@@ -176,3 +174,10 @@ Unclassified
176174
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
177175

178176
**Related Classes/Methods**: *None*
177+
178+
Unclassified
179+
^^^^^^^^^^^^
180+
181+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
182+
183+
**Related Classes/Methods**: *None*

docs/architecture_overview/overview.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Overview
1919
Unclassified["Unclassified"]
2020
Unclassified["Unclassified"]
2121
Unclassified["Unclassified"]
22+
Unclassified["Unclassified"]
2223
Reddit_Client -- "loads settings from" --> Configuration_Manager
2324
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
2425
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -28,7 +29,6 @@ Overview
2829
Listing_Streaming -- "fetches data via" --> Reddit_Client
2930
Listing_Streaming -- "generates" --> Reddit_Data_Models
3031
click Reddit_Client href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Reddit_Client.html" "Details"
31-
click Configuration_Manager href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Configuration_Manager.html" "Details"
3232
click Low_Level_API_Connector href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Low_Level_API_Connector.html" "Details"
3333
click Object_Transformer href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Object_Transformer.html" "Details"
3434
click Reddit_Data_Models href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Reddit_Data_Models.html" "Details"
@@ -62,8 +62,6 @@ The primary interface for interacting with the Reddit API, managing authenticati
6262
Configuration Manager
6363
^^^^^^^^^^^^^^^^^^^^^
6464

65-
:ref:`Expand <Configuration_Manager>`
66-
6765
Manages loading and accessing PRAW's configuration settings.
6866

6967
**Related Classes/Methods**:
@@ -176,3 +174,10 @@ Unclassified
176174
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
177175

178176
**Related Classes/Methods**: *None*
177+
178+
Unclassified
179+
^^^^^^^^^^^^
180+
181+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
182+
183+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)