gaspersic/solana
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Eliminate doc warnings and fix some markdown (#18566)

Browse Source 
* Fix link target in doc comment

* Fix formatting of log examples in process_instruction

* Fix doc markdown in solana-gossip

* Fix doc markdown in solana-runtime

* Escape square braces in doc comments to avoid warnings

* Surround 'account references' doc items in code spans to avoid warnings

* Fix code block in loader_upgradeable_instruction

* Fix doctest for loader_upgradable_instruction
This commit is contained in:
Brian Anderson
2021-07-15 19:40:07 -05:00
committed by GitHub
parent aeb30fa873
commit 37ee0b5599
12 changed files with 208 additions and 170 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
sdk/src/process_instruction.rs
View File

@ -243,7 +243,10 @@ pub mod stable_log {
/// Log a program invoke.
///
/// The general form is:
/// "Program <address> invoke [<depth>]"
///
/// ```notrust
/// "Program <address> invoke [<depth>]"
/// ```
pub fn program_invoke(
logger: &Rc<RefCell<dyn Logger>>,
program_id: &Pubkey,
@ -255,7 +258,11 @@ pub mod stable_log {
/// Log a message from the program itself.
///
/// The general form is:
/// "Program log: <program-generated output>"
///
/// ```notrust
/// "Program log: <program-generated output>"
/// ```
///
/// That is, any program-generated output is guaranteed to be prefixed by "Program log: "
pub fn program_log(logger: &Rc<RefCell<dyn Logger>>, message: &str) {
ic_logger_msg!(logger, "Program log: {}", message);
@ -264,7 +271,10 @@ pub mod stable_log {
/// Log successful program execution.
///
/// The general form is:
/// "Program <address> success"
///
/// ```notrust
/// "Program <address> success"
/// ```
pub fn program_success(logger: &Rc<RefCell<dyn Logger>>, program_id: &Pubkey) {
ic_logger_msg!(logger, "Program {} success", program_id);
}
@ -272,7 +282,10 @@ pub mod stable_log {
/// Log program execution failure
///
/// The general form is:
/// "Program <address> failed: <program error details>"
///
/// ```notrust
/// "Program <address> failed: <program error details>"
/// ```
pub fn program_failure(
logger: &Rc<RefCell<dyn Logger>>,
program_id: &Pubkey,