Skip to content

Make codec more discoverable #2475

Closed
@Darksonn

Description

The codec module in tokio-util is currently not as discoverable as I would like. Even when people see the tokio-util crate, I often see people get confused and think its some multi-media thing.

One thing that needs to be improved in particular is the top-level module description, which currently is

Utilities for encoding and decoding frames.

This should be improve to something that makes it clear that this is about streams and sinks, and splitting things into multiple messages.

Ideas for additional ways of making it discoverable are very welcome!

Metadata

Assignees

No one assigned

    Labels

    A-tokio-utilArea: The tokio-util crateC-maintenanceCategory: PRs that clean code up or issues documenting cleanup.M-codecModule: tokio-util/codecT-docsTopic: documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions