Skip to content

Commit 5b34449

Browse files
committed
module level docs.
1 parent d02a188 commit 5b34449

File tree

1 file changed

+10
-0
lines changed
  • crates/processing_pyo3/src

1 file changed

+10
-0
lines changed

crates/processing_pyo3/src/lib.rs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
//! # processing_pyo3
2+
//!
3+
//! A Python module that exposes libprocessing using pyo3.
4+
5+
//! In processing4 Java, the sketch runs implicitly inside a class that extends PApplet and
6+
//! executes main. This means that all PAplet methods can be called directly without an explicit
7+
//! receiver.
8+
//!
9+
//! To allow Python users to create a similar experience, we provide module-level
10+
//! functions that forward to a singleton Graphics object behind the scenes.
111
mod glfw;
212
mod graphics;
313

0 commit comments

Comments
 (0)