Skip to content

Consolidate THRIFT.md into rustdoc comments #8571

@alamb

Description

@alamb

Is your feature request related to a problem or challenge? Please describe what you are trying to do.

In the (epic!) PR that introduces the new thrift decoder from @etseidl

The instructions and documentation for using the new thrift decoder are in a file called THRIFT.md

While the documentation is excellent, it has at least two challenges:

  1. The doc examples are not tested regularly (and thus will likely slow bitrot / stop working)
  2. It may be hard to find when looking through the code in the repo

Describe the solution you'd like
I would like the contents of THRIFT.md integrated into the codebase as doc comments

Describe alternatives you've considered

Additional context
There is some related discussion here

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementAny new improvement worthy of a entry in the changelog

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions