Skip to content
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.

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

Documentation updates #570

Merged
merged 10 commits into from
Sep 27, 2024
Merged

Documentation updates #570

merged 10 commits into from
Sep 27, 2024

Conversation

aspect
Copy link
Collaborator

@aspect aspect commented Sep 26, 2024

This PR includes documentation updates to RK modules (wallet, consensus client, RPC/wRPC).

Also adding CI pass for cargo doc (as it appears we have not been running this in CI) and fixing various documentation link issues.

Copy link
Collaborator

@coderofstuff coderofstuff left a comment

Choose a reason for hiding this comment

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

I just have a bunch of questions here first

wallet/keys/src/prelude.rs Outdated Show resolved Hide resolved
consensus/client/src/lib.rs Show resolved Hide resolved
consensus/core/src/config/bps.rs Show resolved Hide resolved
mining/src/feerate/fee_estimation.ipynb Outdated Show resolved Hide resolved
@@ -9,6 +22,7 @@ pub mod notify;
pub mod wasm;

pub mod prelude {
//! Glob imports of the most commonly used types and traits in this crate.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Glob appears here again

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Glob is sometimes used as a reference to wildcards.

Replaced wording with "Re-export".

wallet/core/src/lib.rs Show resolved Hide resolved
wallet/core/src/utxo/processor.rs Show resolved Hide resolved
wallet/core/src/wallet/mod.rs Outdated Show resolved Hide resolved
@coderofstuff coderofstuff merged commit 035a394 into kaspanet:master Sep 27, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants