Skip to content
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

Improve the Rustdoc comment and comments #36

Merged
merged 3 commits into from
Jul 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions git/src/internal/object/tag.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
//! and then move the tag to a different commit, the tag will still point to the original commit.
//!
//! The lightweight just a text file with the commit hash in it, and the file name is the tag name.
//! If one of -a, -s, or -u <key-id> is passed, the command creates a tag object, and requires a tag
//! message. Unless -m <msg> or -F <file> is given, an editor is started for the user to type in the
//! If one of -a, -s, or -u \<key-id\> is passed, the command creates a tag object, and requires a tag
//! message. Unless -m \<msg\> or -F \<file\> is given, an editor is started for the user to type in the
//! tag message.
//!
//! ```bash
Expand Down
7 changes: 1 addition & 6 deletions git/src/internal/object/tree.rs
Original file line number Diff line number Diff line change
Expand Up @@ -180,12 +180,7 @@ impl TreeItem {
/// ```bash
/// <mode> <name>\0<binary object ID>
/// ```
///
/// # Example
/// ```rust
// let bytes = Vec::<u8>::new().to_bytes();
// let tree_item = TreeItem::new_from_bytes(bytes.as_slice()).unwrap();
/// ```
///
#[allow(unused)]
pub fn new_from_bytes(bytes: &[u8]) -> Result<Self, GitError> {
let mut parts = bytes.splitn(2, |b| *b == b' ');
Expand Down
4 changes: 3 additions & 1 deletion src/main.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
//!
//! Mega is an engine for managing a monorepo. It functions similarly to Google's Piper and helps to streamline Git
//! and trunk-based development for large-scale projects.
//!
//!
//!
Expand All @@ -13,6 +14,7 @@ fn main() {
env::set_var("RUST_LOG", "debug");
tracing_subscriber::fmt::init();
dotenvy::dotenv().ok();

// Parse the command line arguments
let result = cli::parse();

Expand Down