Skip to content
This repository has been archived by the owner on Sep 1, 2023. It is now read-only.

Some modules are missing from docs.rs #43

Open
Nuttymoon opened this issue Mar 30, 2023 · 5 comments · Fixed by #86
Open

Some modules are missing from docs.rs #43

Nuttymoon opened this issue Mar 30, 2023 · 5 comments · Fixed by #86
Assignees

Comments

@Nuttymoon
Copy link
Contributor

Nuttymoon commented Mar 30, 2023

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...)

@gyuho gyuho added the help wanted Extra attention is needed label May 29, 2023
@Nuttymoon
Copy link
Contributor Author

Couldn't we just enable documentation for all features?

[package.metadata.docs.rs]
all-features = true

@richardpringle
Copy link
Collaborator

richardpringle commented May 30, 2023

@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
Copy link
Collaborator

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

@Nuttymoon
Copy link
Contributor Author

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 richardpringle removed the help wanted Extra attention is needed label Jun 1, 2023
@richardpringle
Copy link
Collaborator

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

@richardpringle richardpringle reopened this Jun 1, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants