Skip to content

Commit be750c3

Browse files
committed
Fix formatting of __init__.py comments in documentation
1 parent 10d4fe8 commit be750c3

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/examples/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ examples/
5353
├── a/ # Plugin A
5454
│ ├── plugin.json # Metadata
5555
│ ├── plugin.py # Entrypoint
56-
│ └── __init__.py # Public API
56+
│ └── __init__.py # Public API
5757
└── b/ # Plugin B
5858
├── plugin.json
5959
├── plugin.py

docs/guide/context-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,11 +156,11 @@ Typical plugin structure:
156156
my_plugin/
157157
├── plugin.json # Metadata
158158
├── plugin.py # Entrypoint (initialization)
159-
├── __init__.py # Public API
159+
├── __init__.py # Public API
160160
└── internal.py # Internal modules
161161
```
162162

163-
### __init__.py Pattern
163+
### \_\_init\_\_.py Pattern
164164

165165
Export your public API from `__init__.py`:
166166

docs/guide/creating-plugins.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Creating Plugins
1+
# Creating Plugins ???
22

33
Learn how to create well-structured plugins for PKL.
44

@@ -18,7 +18,7 @@ A complete plugin:
1818
my_plugin/
1919
├── plugin.json # Metadata
2020
├── plugin.py # Entrypoint
21-
├── __init__.py # Public API
21+
├── __init__.py # Public API
2222
├── internal.py # Internal modules
2323
└── subplugins/ # Child plugins (optional)
2424
```
@@ -66,7 +66,7 @@ def cleanup():
6666
log.info("Cleaning up!")
6767
```
6868

69-
### Public API (__init__.py)
69+
### Public API (\_\_init\_\_.py)
7070

7171
Export your public API:
7272

0 commit comments

Comments
 (0)