gitui icon indicating copy to clipboard operation
gitui copied to clipboard

Minimal docs at module level

Open peso opened this issue 8 months ago • 3 comments

This Pull Request provides minimal top-level documentation. This makes the initial navigation of cargo docs easier.

It changes the following:

  • add module comment to main
  • add module comment to tabs
  • add module comment to cmdbar
  • add module comment to components
  • add module comment to components::commitlist
  • add crate comments to asyncgit

I followed the checklist:

  • [ ] I added unittests
  • [x] I ran make check without errors
  • [x] I tested the overall application
  • [ ] I added an appropriate item to the changelog

peso avatar May 12 '25 18:05 peso

Next time, I should remember running rustfmt and cargo clippy before pushing ...

peso avatar May 12 '25 19:05 peso

Removed commitlist and cmdbar mod coments. I have tried to make main.rs more generic while still giving enough information that you don't have to read every module doc before knowing which is relevant to you.

peso avatar May 29 '25 11:05 peso

github says there is one more requested change, but I think I did address them all. Did I miss one?

peso avatar Jun 05 '25 14:06 peso