Skip to content

Refine documentation in interpreter.rs #6566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
77axel wants to merge 7 commits into from
Closed

Refine documentation in interpreter.rs #6566

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c35986a
Refine documentation in interpreter.rs
77axel Dec 28, 2025
2cae714
Auto-format: cargo fmt --all
github-actions[bot] Dec 28, 2025
ec9cc6d
Improve error message for non-Unicode paths
77axel Dec 28, 2025
7e7428b
Auto-format: cargo fmt --all
github-actions[bot] Dec 28, 2025
72b4343
Use consistent make_module naming in all doc examples
77axel Dec 29, 2025
e1eebd3
Merge remote changes
77axel Dec 29, 2025
c4d502a
Auto-format: cargo fmt --all
github-actions[bot] Dec 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Auto-format: cargo fmt --all
  • Loading branch information
@github-actions
github-actions[bot] committed Dec 29, 2025
commit c4d502acd230f28c147dc17074f9a18eb679075a
2 changes: 1 addition & 1 deletion src/interpreter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ pub type InitHook = Box<dyn FnOnce(&mut VirtualMachine)>;
/// // Your module implementation
/// # todo!()
/// }
Comment on lines +37 to +40
Copy link
Copy Markdown
Member

@youknowone youknowone Dec 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is still misleading about making a module.

Suggested change
/// fn make_module(vm: &VirtualMachine) -> PyRef<PyModule> {
/// // Your module implementation
/// # todo!()
/// }
/// #[pymodule]
/// mod your_module {}

///
///
/// let interpreter = InterpreterConfig::new()
/// .init_stdlib()
/// .add_native_module(
Expand Down