search

ava-labs / avalanche-types-rs

Avalanche primitive types in Rust (experimental)
Other
32 stars 10 forks source link

Some modules are missing from docs.rs #43

Open Nuttymoon opened 1 year ago

Nuttymoon commented 1 year ago

I recently found out about modules such as jsonrpc::client or wallet that are hidden behind features.

They are not present in the documentation at https://docs.rs/avalanche-types/latest/avalanche_types which is not very user-friendly. (I just realized that I have recoded things that were already implemented...)

Nuttymoon commented 1 year ago

Couldn't we just enable documentation for all features?

[package.metadata.docs.rs]
all-features = true
richardpringle commented 1 year ago

@Nuttymoon, do you want to create a PR with the change and we can try it out?

I think you also want

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]

The latter should make it so types have that Available on crate features <feature_name> only message.

(if not, I can do it)

richardpringle commented 1 year ago

Sorry @Nuttymoon... ended up doing it myself in #86 as I saw it was a little more involved.

Nuttymoon commented 1 year ago

Sorry @Nuttymoon... ended up doing it myself in #86 as I saw it was a little more involved.

No worries! As long as the issue is corrected I am happy haha

richardpringle commented 1 year ago

Re-opening. We can close when the new docs are published