-
-
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
Open
peso
wants to merge
7
commits into
gitui-org:master
Choose a base branch
from
peso:doc-modules
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
c8b0f66
Module dokumentation for main
peso 544776a
Module documentation for tabs
peso 65cb99d
Module documentation for cmdbar
peso 1fb2b35
Module documentation for components
peso d71aa95
Module documentation for components::commitlist
peso 0c98880
Crate documentation for asyncgit
peso a94e903
Fix doc warnings in asyncgit
peso File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
||
*/ | ||
|
||
mod changes; | ||
mod command; | ||
mod commit_details; | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,36 @@ | ||
//! | ||
//! The gitui program is a text-based UI for working with a Git repository. | ||
//! The main navigation occurs between a number of tabs. | ||
//! When you execute commands, the program may use popups to communicate | ||
//! with the user. It is possible to customize the keybindings. | ||
//! | ||
//! | ||
//! ## Internal Modules | ||
//! The top-level modules of gitui can be grouped as follows: | ||
//! | ||
//! - User Interface | ||
//! - [tabs] for main navigation | ||
//! - [components] for visual elements used on tabs | ||
//! - [popups] for temporary dialogs | ||
//! - [ui] for tooling like scrollbars | ||
//! - Git Interface | ||
//! - [asyncgit] (crate) for async operations on repository | ||
//! - Distribution and Documentation | ||
//! - Project files: README.md, LICENSE.md, CHANGELOG.md, CONTRIBUTING.md, etc | ||
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. since we cannot programmatically keep these comments up to date lets keep it more high level |
||
//! - Github CI: See .github/ | ||
//! - Installation: wix/ holds an installer for Windows | ||
//! - Usage: `KEY_CONIG.md`, THEMES.md, FAQ.md | ||
//! | ||
//! ## Included Crates | ||
//! Some crates are part of the gitui repository: | ||
//! - [asyncgit] for Git operations in the background. | ||
//! - git2-hooks (used by asyncgit). | ||
//! - git2-testing (used by git2-hooks). | ||
//! - invalidstring used by asyncgit for testing with invalid strings. | ||
//! - [filetreelist] for a tree view of files. | ||
//! - [scopetime] for measuring execution time. | ||
//! | ||
|
||
#![forbid(unsafe_code)] | ||
#![deny( | ||
unused_imports, | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
apis