Skip to content

Fix documentation warnings #7145

Open
@etorreborre

Description

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions