Skip to content

Commit

Permalink
SDK doc fixes (#3133)
Browse files Browse the repository at this point in the history
* fix decode-error doc links

* fix redundant link in program-option

* mark as source code to avoid unclosed HTML tag warning

* fix url
  • Loading branch information
kevinheavey authored Oct 11, 2024
1 parent b81d197 commit 8d507cb
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions sdk/decode-error/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ use num_traits::FromPrimitive;
/// `FromPrimitive`, it is only used correctly when the caller is certain of the
/// original error type.
///
/// [`ProgramError`]: crate::program_error::ProgramError
/// [`ProgramError::Custom`]: crate::program_error::ProgramError::Custom
/// [`ProgramError`]: https://docs.rs/solana-program-error/latest/solana_program_error/enum.ProgramError.html
/// [`ProgramError::Custom`]: https://docs.rs/solana-program-error/latest/solana_program_error/enum.ProgramError.html#variant.Custom
/// [`ToPrimitive`]: num_traits::ToPrimitive
pub trait DecodeError<E> {
fn decode_custom_error_to_enum(custom: u32) -> Option<E>
Expand Down
2 changes: 1 addition & 1 deletion sdk/program-option/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -882,7 +882,7 @@ impl<T: Clone> Clone for COption<T> {
}

impl<T> Default for COption<T> {
/// Returns [`COption::None`][COption::None].
/// Returns [`COption::None`]
///
/// # Examples
///
Expand Down
4 changes: 2 additions & 2 deletions sdk/src/signer/signers.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ pub trait Signers {
/// Any `T` where `T` impls `IntoIterator` yielding
/// `Signer`s implements `Signers`.
///
/// This includes [&dyn Signer], [Box<dyn Signer>],
/// [&dyn Signer; N], Vec<dyn Signer>, Vec<Keypair>, etc.
/// This includes `[&dyn Signer]`, `[Box<dyn Signer>]`,
/// `[&dyn Signer; N]`, `Vec<dyn Signer>`, `Vec<Keypair>`, etc.
///
/// When used as a generic function param, `&T`
/// should be used instead of `T` where T: Signers, due to the `?Sized` bounds on T.
Expand Down

0 comments on commit 8d507cb

Please sign in to comment.