Skip to content

Commit

Permalink
Copy non-macro code generators paragraph from readme to rustdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
dtolnay committed May 8, 2023
1 parent a901e98 commit 05afe13
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,17 @@
//! }
//! };
//! ```
//!
//! <br>
//!
//! # Non-macro code generators
//!
//! When using `quote` in a build.rs or main.rs and writing the output out to a
//! file, consider having the code generator pass the tokens through
//! [prettyplease] before writing. This way if an error occurs in the generated
//! code it is convenient for a human to read and debug.
//!
//! [prettyplease]: https://github.com/dtolnay/prettyplease

// Quote types in rustdoc of other crates get linked to here.
#![doc(html_root_url = "https://docs.rs/quote/1.0.26")]
Expand Down

0 comments on commit 05afe13

Please sign in to comment.