Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor fixes to docstrings of functions #1868

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion jrnl/journals/DayOneJournal.py
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ def write(self) -> None:

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:
Expand Down
3 changes: 2 additions & 1 deletion jrnl/journals/Journal.py
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,8 @@ def limit(self, n: int | None = None) -> None:

@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.
Expand Down