Add comments

Author: kajuburfi

src/main.rs

@@ -59,6 +59,7 @@ struct Cli {
     print_config: bool,
 
     /// Opens a file, in `jrnl_folder`, with any name, just to add some notes.
+    /// You can also use `--open e` to open `events.md` since it is a default file.
     #[arg(long, group = "main")]
     open: Option<String>,
 
@@ -168,6 +169,7 @@ fn main() {
     };
     let args_open = match args.open.as_deref() {
         None => "",
+        Some("e") => "events.md",
         Some(entry) => &entry,
     };
 

src/utils.rs

@@ -1073,6 +1073,8 @@ pub fn gen_report_year(year: i32) {
     println!("{}", table);
 }
 
+/// Read the `events.md` file located in `jrnl_folder`, and returns a Vector containing
+/// a tuple of NaiveDate and the respective String.
 pub fn read_events() -> Vec<(NaiveDate, String)> {
     let file_result = File::open(format!("{}/jrnl_folder/events.md", get_default_path()));
     let file = match file_result {