From 02bcc662a541756b71352ea7858230620cc503b2 Mon Sep 17 00:00:00 2001 From: Mudit Date: Tue, 12 Mar 2024 20:56:11 +0530 Subject: [PATCH 1/2] Minor fixes to docstrings of functions --- jrnl/journals/DayOneJournal.py | 2 +- jrnl/journals/Journal.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/jrnl/journals/DayOneJournal.py b/jrnl/journals/DayOneJournal.py index ace6a5f4..e12c22c8 100644 --- a/jrnl/journals/DayOneJournal.py +++ b/jrnl/journals/DayOneJournal.py @@ -166,7 +166,7 @@ class DayOne(Journal): def editable_str(self) -> str: """Turns the journal into a string of entries that can be edited - manually and later be parsed with eslf.parse_editable_str.""" + manually and later be parsed with self.parse_editable_str.""" return "\n".join([f"{str(e)}\n# {e.uuid}\n" for e in self.entries]) def _update_old_entry(self, entry: Entry, new_entry: Entry) -> None: diff --git a/jrnl/journals/Journal.py b/jrnl/journals/Journal.py index d1054814..f5365fb4 100644 --- a/jrnl/journals/Journal.py +++ b/jrnl/journals/Journal.py @@ -224,7 +224,7 @@ class Journal: @property def tags(self) -> list[Tag]: - """Returns a set of tuples (count, tag) for all tags present in the journal.""" + """Returns a list of Tag instances enumerating all the tags present in the journal.""" # Astute reader: should the following line leave you as puzzled as me the first # time I came across this construction, worry not and embrace the ensuing moment # of enlightment. From 9bf3d8acebdabdf47932b81ae9cbce05c9d8cc1f Mon Sep 17 00:00:00 2001 From: Micah Jerome Ellison Date: Sun, 24 Mar 2024 08:34:26 -0700 Subject: [PATCH 2/2] Add line break to appease linter 88-char line length max --- jrnl/journals/Journal.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/jrnl/journals/Journal.py b/jrnl/journals/Journal.py index f5365fb4..28478da1 100644 --- a/jrnl/journals/Journal.py +++ b/jrnl/journals/Journal.py @@ -224,7 +224,8 @@ class Journal: @property def tags(self) -> list[Tag]: - """Returns a list of Tag instances enumerating all the tags present in the journal.""" + """Returns a list of Tag instances enumerating all the tags present in the + journal.""" # Astute reader: should the following line leave you as puzzled as me the first # time I came across this construction, worry not and embrace the ensuing moment # of enlightment.