orium / cargo-rdme

Cargo command to create the README.md from your crate's documentation
Mozilla Public License 2.0
126 stars 5 forks source link

Feature Inquiry - Add clap output #187

Closed c-git closed 9 months ago

c-git commented 10 months ago

This tool look really useful. I am inquiring if adding the clap help output to the readme has been considered as a feature. I want it for my use case so just asking if it's already been considered. Wasn't able to find anything in the issues.

  1. Is this something that would be suitable to add to this tool?
  2. If it is considered a desirable feature and I do get time to add it, is there anything I need to know before I create the PR other than what's in the contribution guidelines?
orium commented 9 months ago

Hi. I'm not entirely sure I want more than rustdoc in the cargo-rdme. I've though about it, and maybe one day I might decide to go that path, but not something I'm considering right now.

c-git commented 9 months ago

No problem, thanks for the feedback. If you decide to go down that path feel free to follow up with me as I will likely do it for my own use once I make some time.