Fix configuration slashes and indentation in advanced usage documentation

[aallbrig]

Update Advanced Usage documentation

Changes

1. Update \ to / from the first code snippet from Multiple journal files section.

   I had copy and pasted this into my ~/.config/jrnl/jrnl.yaml and found that journal files were created in my current working directory as ~\work.txt and ~\journal.txt.

   

   Manual test

   # Confirm the issue from current version of docs
   cd /tmp
   cat << HERE > ~/.config/jrnl/jrnl.yaml
   journals:
     default: ~\test-journal.txt
     work: ~\test-work.txt
   HERE
   ls *.txt
   
   jrnl at 3:30pm: Test default journal
   jrnl work at 4:30pm: Test work journal
   ls *.txt
   echo '*.txt files should exist in your current directory (which confirms the issue!)'
   rm -f *.txt
   
   # Confirm the doc changes work as intended
   rm -f ~/test-journal.txt ~/test-work.txt
   
   cat << HERE > ~/.config/jrnl/jrnl.yaml
   journals:
     default: ~/test-journal.txt
     work: ~/test-work.txt
   HERE
   
   jrnl at 3:30pm: Test default journal
   jrnl work at 4:30pm: Test work journal
   
   ls *.txt
   echo 'No *.txt should exist in your current directory'

2. Indent code snippet from override defaults per journal example from Multiple journal files section.

   Taking the snippet as-is, I got TypeError: argument of type 'NoneType' is not iterable errors. However; updating the YAML to have an indents resolved the issue.

   

   Manual test

   # Confirm the issue from current version of docs
   cd /tmp
   cat << HERE > ~/.config/jrnl/jrnl.yaml
   journals:
   default: ~/test-journal.txt
   work:
     journal: ~/test-work.txt
     encrypt: true
   food: ~/test-food.txt
   HERE
   
   # Errors will to occur when trying to write journal entries
   jrnl at 3:30pm: Test default journal
   jrnl work at 4:30pm: Test work journal
   jrnl food at 5:30pm: Test food journal
   
   jrnl -n 1
   jrnl work -n 1
   jrnl food -n 1
   
   
   # Confirm the doc changes work as intended
   cat << HERE > ~/.config/jrnl/jrnl.yaml
   journals:
     default: ~/test-journal.txt
     work:
       journal: ~/test-work.txt
       encrypt: true
     food: ~/test-food.txt
   HERE
   
   jrnl at 3:30pm: Test default journal
   jrnl work at 4:30pm: Test work journal
   jrnl food at 5:30pm: Test food journal
   
   jrnl -n 1
   jrnl work -n 1
   jrnl food -n 1

Documentation Before Changes

Documentation After Changes

My motivation for these changes are to improve the advanced usage documentation.

Checklist

• The code change is tested and works locally.
• Tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• Have you followed the guidelines in our Contributing document?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?
• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you written new tests for your core changes, as applicable?

[micahellison]

Thanks for this change. I was worried about Windows users, but I tested out the ~/ format on Windows and it works just fine.