-
-
Notifications
You must be signed in to change notification settings - Fork 613
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
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,7 @@ | ||
/*! | ||
Components are the visible building blocks of tabs. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. not adding much value There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I disagree, mostly because of the word "component". For someone who is not familiar with the code base components could be anything. One thing that got me sidetracked at the beginning was that "gitui::components" sits next to "gitui::ui". My first thought was that components therefore must be something different from ui. This comment limits components to be visible things used by tabs. As a developer I can now look at the screen and have a good idea of what a gitui::component is. |
||
*/ | ||
|
||
mod changes; | ||
mod command; | ||
mod commit_details; | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
technically not accurate because we also offer a bunch of
sync
apisThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok. Add comments on sync part.