Why are crate docs a pain in the ass to understand usage?

This page summarizes the projects mentioned and recommended in the original post on /r/rust

Our great sponsors
  • WorkOS - The modern identity platform for B2B SaaS
  • InfluxDB - Power Real-Time Data Analytics at Scale
  • SaaSHub - Software Alternatives and Reviews
  • rush

    Rusty Shell - A experimental shell written in rust :smile: (by js-simp)

  • Sure, so I've forked a rust repo, called rush, and I've started playing around, fixing a few things, and adding some functionality. https://github.com/js-simp/rush I want to implement the hints feature, (suggestions for commands based on history) I believe I should make use of the hint module, but I have no idea how to implement it. There's a struct called HistoryHinter within hint, with a pub fn called hint. I have no idea how to adopt it to the existing code, what has to be imported, how to get started...

  • rustyline

    Readline Implementation in Rust

  • Not sure if it will help in this case (docs always take effort to write and make good), but most crates have an examples directory in the root of their repo which can be helpful in the absence of guide-level docs https://github.com/kkawakam/rustyline/tree/master/examples

  • WorkOS

    The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

    WorkOS logo
NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts