Skip to content
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.

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

Add -r flag explanation for release builds in Maturin quickstart guide #2210

Closed
Smart-SangGe opened this issue Sep 6, 2024 · 1 comment · Fixed by #2211
Closed

Add -r flag explanation for release builds in Maturin quickstart guide #2210

Smart-SangGe opened this issue Sep 6, 2024 · 1 comment · Fixed by #2211
Labels
documentation Documentation needs improvement good first issue Good for newcomers

Comments

@Smart-SangGe
Copy link
Contributor

Description: The tutorial doesn't mention the -r flag, which enables building with an optimized target (release mode). This omission caused me to spend several hours trying to optimize my code manually. Eventually, I discovered the -r flag, which significantly improved the performance of my bindings, making them run much faster.

Suggestion: Please update the tutorial to include the -r flag and explain its impact on performance, so that others can avoid unnecessary troubleshooting and immediately take advantage of the optimization.

@Smart-SangGe Smart-SangGe added the enhancement New feature or request label Sep 6, 2024
@messense messense added good first issue Good for newcomers documentation Documentation needs improvement and removed enhancement New feature or request labels Sep 6, 2024
@messense
Copy link
Member

messense commented Sep 6, 2024

Pull requests are welcome.

Note that maturin build is basically cargo build with some extensions so we usually don't write out everything that cargo build supports.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation needs improvement good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants