Skip to content

framing-sv2 doc cmts do not conform to standard #1178

@rrybarczyk

Description

@rrybarczyk

As a part of the protocols documentation and refactor effort in #845, Rust doc comments were added to the framing-sv2 crate in #848. However, this was done before the team fully finalized the standardization for the Rust doc comments in discussion #970.

The content of the framing-sv2 documentation post-#845 is sound, only the formatting needs to be updated. A README.md will also be added, following the established standard.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationprotocolsLowest level protocol logic

Type

No type

Projects

Status

Done ✅

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions