Skip to content

stake-contract: Add docs comments #3304

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

Open
moCello wants to merge 1 commit into
base: master
Choose a base branch
from
Open

stake-contract: Add docs comments #3304

Show file tree
Hide file tree
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
12 changes: 12 additions & 0 deletions contracts/stake/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,21 @@
//
// Copyright (c) DUSK NETWORK. All rights reserved.

//! # Stake Contract Documentation
//!
//! This contract manages staking-related state for the Dusk Network,
//! implementing core functions that facilitate the management of stakes,
//! rewards and penalties.
//!
//! For a detailed explanation of staking mechanisms refer to the
//! [Dusk Whitepaper](https://dusk-cms.ams3.digitaloceanspaces.com/Dusk_Whitepaper_2024_4db72f92a1.pdf)
Copy link
Contributor

@fed-franz fed-franz Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure I would link the whitepaper to be honest... it's not that it's much more detailed than the docs and having a link to digitaloceanspaces feels a bit awkward to be.

Copy link
Member Author

@moCello moCello Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a more suitable link to the docs?

Copy link
Contributor

@fed-franz fed-franz Jun 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would simply leave the one below (docs.dusk.network). But you can also add a link to https://github.com/dusk-network/dusk-protocol

//! and [Dusk Documentation](https://docs.dusk.network).
#![cfg_attr(target_family = "wasm", no_std)]
#![cfg(target_family = "wasm")]
#![feature(arbitrary_self_types)]
#![deny(missing_docs)]
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(unused_crate_dependencies)]
#![deny(unused_extern_crates)]

Expand Down
Loading
Loading