[I] Consolidate THRIFT.md into rustdoc comments [arrow-rs]

["alamb (via GitHub)" <gi...@apache.org>]

alamb opened a new issue, #8571:
URL: https://github.com/apache/arrow-rs/issues/8571

   **Is your feature request related to a problem or challenge? Please describe what you are trying to do.**
   
   - part of 
   
   In the (epic!) PR that introduces the new thrift decoder from @etseidl 
   - https://github.com/apache/arrow-rs/pull/8530
   
   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
   
   **Describe alternatives you've considered**
   <!--
   A clear and concise description of any alternative solutions or features you've considered.
   -->
   
   **Additional context**
   <!--
   Add any other context or screenshots about the feature request here.
   -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [I] Consolidate THRIFT.md into rustdoc comments [arrow-rs]

["etseidl (via GitHub)" <gi...@apache.org>]

etseidl commented on issue #8571:
URL: https://github.com/apache/arrow-rs/issues/8571#issuecomment-3403974618

   I've hit my first roadblock while trying to pull `THRIFT.md` into `parquet/src/file/metadata/thrift/mod.rs`. The thrift decoding code has been kept private, but doctest can only use public APIs.
   
   The only workaround is to ignore all the code blocks, but then that defeats the purpose of point 1. The markdown is rendered properly, so point 2 is at least addressed.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org