ockam icon indicating copy to clipboard operation
ockam copied to clipboard

Fix documentation warnings

Open etorreborre opened this issue 2 years ago • 6 comments

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

etorreborre avatar Dec 15 '23 10:12 etorreborre

Would you please assign it to me?

Riahiamirreza avatar Dec 22 '23 14:12 Riahiamirreza

Hi @Riahiamirreza please, it's all yours.

etorreborre avatar Dec 22 '23 14:12 etorreborre

@etorreborre Anyone working on it?

Ankit8848 avatar Dec 26 '23 21:12 Ankit8848

@Ankit8848 I'm currently working on it.

Riahiamirreza avatar Dec 27 '23 05:12 Riahiamirreza

@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
   |

Riahiamirreza avatar Feb 29 '24 16:02 Riahiamirreza

Hi @etorreborre I have created a PR that solves all the warnings that we previously get. Please have a look at it

PsychoPunkSage avatar Aug 01 '24 06:08 PsychoPunkSage