Fix documentation warnings
Running cargo doc raises many documentation warnings about missing elements. For example:
/// Create the [`SecureChannel`] [`PurposeKey`]
| ^^^^^^^^^^ no item named `PurposeKey` in scope
We should fix this either by:
- importing the right scope
- or the right element name
- or in some cases not quote a struct name (for example if this is a concrete example of an abstract crate usage)
We love helping new contributors! If you have questions or need help as you work on your first Ockam contribution, please leave a comment on this discussion. If you're looking for other issues to contribute to, checkout this discussion and labels - Good first issue or Help wanted
Would you please assign it to me?
Hi @Riahiamirreza please, it's all yours.
@etorreborre Anyone working on it?
@Ankit8848 I'm currently working on it.
@etorreborre
Hope you're well,
Would guide me on how to resolve this warning? There's not PurposeKey in the code that I can import. The most similar name I could find is PurposeKeys, which I think is not semantically what I'm searching for.
99 | /// Create the [`SecureChannel`] [`PurposeKey`]
| ^^^^^^^^^^ no item named `PurposeKey` in scope
|
Hi @etorreborre I have created a PR that solves all the warnings that we previously get. Please have a look at it