Chore: Added comments and updated README.md

pimterry · Jan 4, 2024 · 8bbdcd4 · 8bbdcd4
1 parent a49bc86
commit 8bbdcd4
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -156,6 +156,10 @@ Displays the note. Shorthand alias also available with `notes c`.
 
 Combine these together! This opens each matching note in your `$EDITOR` in turn.
 
+### `notes realpath [note-name]`
+
+Displays the path to the note name, if provided. Displays the root path to all notes otherwise.
+
 ## Tell me of the future
 
 All the above works. Here's what's coming next:

diff --git a/notes b/notes
@@ -317,9 +317,10 @@ cat_note() {
 realpath() {
     local note_path=$1
 
+    # If no note name was provided, return notes directory
     if [[ -z "$note_path" ]]; then
         note_path=$notes_dir
-    else
+    else # otherwise, get full path of note
         note_path=$( get_full_note_path "$note_path" )
     fi