Skip to content

docs: make doc comments more terse & accurate #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 31, 2025
Merged

docs: make doc comments more terse & accurate #120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions contracts/guess-the-number/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,12 @@ impl GuessTheNumber {
unsafe { env.storage().instance().get(THE_NUMBER).unwrap_unchecked() }
}

/// readonly function to get the current admin
/// Get current admin
pub fn admin(env: &Env) -> Option<Address> {
env.storage().instance().get(ADMIN_KEY)
}

/// Set a new admin address. This is only callable by the admin.
/// Set a new admin. Only callable by admin.
pub fn set_admin(env: &Env, admin: Address) {
// Check if admin is already set
if env.storage().instance().has(ADMIN_KEY) {
Expand All @@ -106,7 +106,7 @@ impl GuessTheNumber {
env.storage().instance().set(ADMIN_KEY, &admin);
}

// Private helper function to require auth from the admin
/// Private helper function to require auth from the admin
fn require_admin(env: &Env) {
let admin = Self::admin(env).expect("admin not set");
admin.require_auth();
Expand Down
Loading