From bc7a2cb8ef1324e8fb43031df66b3d99437037c7 Mon Sep 17 00:00:00 2001 From: Micah Jerome Ellison Date: Sat, 5 Sep 2020 15:00:53 -0700 Subject: [PATCH] Correct incomplete sentences and markdown formatting issues --- docs/encryption.md | 4 ++-- docs/import-and-export.md | 2 +- docs/overview.md | 8 ++++---- docs/usage.md | 7 ++++--- 4 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/encryption.md b/docs/encryption.md index 146bd2a8..be677ee4 100644 --- a/docs/encryption.md +++ b/docs/encryption.md @@ -74,7 +74,7 @@ decrypt your journal. will still be recoverable even if `jrnl` isn't around anymore. Please use `jrnl --decrypt` if available. -**Example 1** (for jrnl v2 files): +**Example for jrnl v2 files**: ``` python #!/usr/bin/env python3 """ @@ -113,7 +113,7 @@ key = base64.urlsafe_b64encode(kdf.derive(password)) print(Fernet(key).decrypt(ciphertext).decode('utf-8')) ``` -**Example 1** (for jrnl v1 files): +**Example for jrnl v1 files**: ``` python #!/usr/bin/env python3 """ diff --git a/docs/import-and-export.md b/docs/import-and-export.md index 07ed9b09..770a0054 100644 --- a/docs/import-and-export.md +++ b/docs/import-and-export.md @@ -18,7 +18,7 @@ directory, jrnl will export each entry into an individual file jrnl --format json -o my_entries/ ``` -The contents of `my\_entries/` will then look like this: +The contents of `my_entries/` will then look like this: ``` output my_entries/ diff --git a/docs/overview.md b/docs/overview.md index 8f24537d..7969a6c7 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -3,7 +3,7 @@ `jrnl` is a simple journal application for the command line. You can use it to easily create, search, and view journal entries. Journals are -stored as human-readable plain text, and can also be encrypted using [AES +stored as human-readable plain text, and can also be encrypted using [AES encryption](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard). `jrnl` has most of the features you need, and few of the ones you don't. @@ -18,7 +18,8 @@ by almost any electronic device, now and for the foreseeable future. ## Tags To make it easier to find entries later, `jrnl` includes support for inline tags -(the default tag symbol is `@`). Entries can be found and filtered +(the default tag symbol is `@`). Entries can be found and filtered using tags +along with other search criteria. ## Support for Multiple Journals @@ -48,9 +49,8 @@ be exported in a variety of [formats](./formats.md). ## Multi-Platform Support -`jrnl` is compatible with most operating systems. You can download it using one +`jrnl` is compatible with most operating systems. You can [download](./installation.md) it using one of a variety of package managers, or you can build from source. -See the [installation page](./installation.md) for more information. ## Open-Source diff --git a/docs/usage.md b/docs/usage.md index d56c9418..fbd4c6c8 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -83,9 +83,10 @@ _now_), the following options are equivalent: - `jrnl *Best day of my life.` - `jrnl Best day of my life.*` -!!! note Make sure that the asterisk (`*`) is **not** surrounded by whitespaces. -`jrnl Best day of my life! *` will not work because the `*` character has a -special meaning in most shells. +!!! note + Make sure that the asterisk (`*`) is **not** surrounded by whitespaces. + `jrnl Best day of my life! *` will not work because the `*` character has a + special meaning in most shells. ## Viewing Entries ##