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 5 commits into
base: master
Choose a base branch
from
Open

Minimal docs at module level #2639

wants to merge 5 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 3 times, most recently from 249101a to cbdba94 Compare May 12, 2025 19:20
@peso
Copy link
Contributor Author

peso commented May 12, 2025

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

Copy link
Collaborator

@extrawurst extrawurst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets remove commitlist and cmdbar mod comments as it feels arbitrary to only add them for these.

In general I dont want to list stuff that will easily get outdated like in your main.rs comment.

I prefer a mod comment over a parent mod comment explaining its sub-mods

@peso
Copy link
Contributor Author

peso commented May 29, 2025

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 peso force-pushed the doc-modules branch 2 times, most recently from 5ebea4e to 746bb47 Compare June 4, 2025 15:31
@peso peso requested a review from extrawurst June 5, 2025 14:44
@peso
Copy link
Contributor Author

peso commented Jun 5, 2025

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

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.

3 participants