Skip to content

Commit f9876a0

Browse files
authored
Merge pull request #572 from google/docs-updates-for-expansion
Describe rust-analyzer configuration needed.
2 parents 582aa37 + 9d705af commit f9876a0

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/lib.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -169,9 +169,11 @@ use autocxx_engine::IncludeCppEngine;
169169
/// # Did it work? How do I deal with failure?
170170
///
171171
/// Once you've achieved a successful build, you might wonder how to know what
172-
/// bindings have been generated. `cargo expand` will show you. In the (near) future,
173-
/// it's hoped that `rust-analyzer` will gain support for expanding procedural
174-
/// macros and you'll be able to see the bindings from Rust IDEs.
172+
/// bindings have been generated. `cargo expand` will show you. Alternatively,
173+
/// you can get autocompletion within an IDE supported by Rust analyzer. You'll
174+
/// need to enable _both_:
175+
/// * Rust-analyzer: Proc Macro: Enable
176+
/// * Rust-analyzer: Experimental: Proc Attr Macros
175177
///
176178
/// Either way, you'll find (for sure!) that `autocxx` hasn't been able to generate
177179
/// bindings for all your C++ APIs. This may manifest as a hard failure or a soft

0 commit comments

Comments
 (0)