dnrops
/
anchor
mirror of https://github.com/project-serum/anchor.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

lang: Add example section in `declare_program!` documentation and fix typos (#2936)

This commit is contained in:
acheron 2024-04-28 15:02:30 +02:00 committed by GitHub
parent 499e1e67c6
commit 9761ea6008
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lang/attribute/program/src/lib.rs
View File

@ -30,7 +30,7 @@ pub fn program(
/// declare_program!(program_name);
/// ```
///
/// This generates a module named `external_program` that can be used to interact with the program
/// This generates a module named `program_name` that can be used to interact with the program
/// without having to add the program's crate as a dependency.
///
/// Both on-chain and off-chain usage is supported.
@ -40,11 +40,17 @@ pub fn program(
/// # Note
///
/// Re-defining the same program to use the same definitions should be avoided since this results
/// in larger binary size.
/// in a larger binary size.
///
/// A program should only be defined once. If you have multiple programs that depend on the same
/// definition, you should consider creating a separate crate for the external program definition
/// and reuse it in your programs.
/// and reusing it in your programs.
///
/// # Example
///
/// A full on-chain CPI usage example can be found [here].
///
/// [here]: https://github.com/coral-xyz/anchor/tree/v0.30.0/tests/declare-program
#[proc_macro]
pub fn declare_program(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
parse_macro_input!(input as DeclareProgram)