Skip to content

Minimal docs at module level #2639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Minimal docs at module level #2639

wants to merge 7 commits into from

Conversation

peso
Copy link
Contributor

@peso peso commented May 12, 2025

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
  • I ran make check without errors
  • I tested the overall application
  • I added an appropriate item to the changelog

@peso peso force-pushed the doc-modules branch 2 times, most recently from 44918db to 249101a Compare May 12, 2025 18:24
@peso
Copy link
Contributor Author

peso commented May 12, 2025

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant