Skip to content

Commit

Permalink
Update docstrings and help file.
Browse files Browse the repository at this point in the history
  • Loading branch information
peter88213 committed Jan 14, 2024
1 parent ef0648d commit 54354f2
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/help/desktop.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Select item and hit the **Del** key.
- The _Trash_ chapter is created automatically, if needed.
- When deleting the _Trash_ chapter, all sections are deleted.

- The type of chapters and sections, as well as the editing status of the sections are color coded and can be changed via context menu.
- The type of chapters and sections, as well as the completion status of the sections are color coded and can be changed via context menu.
- Within chapters, sections of the same type and with the same viewpoint can be joined.
- "Notes" and "To do" type chapters can be exported to a separate ODT document.

Expand Down
4 changes: 3 additions & 1 deletion src/noveltreelib/controller/nv_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -891,11 +891,13 @@ def set_level(self, newLevel, elemIds=None):
self._mdl.set_level(newLevel, elemIds)

def set_section_edit_status(self, newStatus, elemIds=None):
"""Set section editing status (Outline/Draft..).
"""Set section completion status (Outline/Draft..).
Positional arguments:
newStatus: int -- New section status to be set.
elemIds: list of IDs to process.
TODO: Rename this method to set_completion_status()
"""
if not self.check_lock():
if elemIds is None:
Expand Down
4 changes: 3 additions & 1 deletion src/noveltreelib/model/nv_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -900,11 +900,13 @@ def set_character_status(self, isMajor, elemIds):
self.set_character_status(isMajor, self.tree.get_children(crId))

def set_section_edit_status(self, newStatus, elemIds):
"""Recursively set section editing status (Outline/Draft..).
"""Recursively set section completion status (Outline/Draft..).
Positional arguments:
newStatus: int -- New section status to be set.
elemIds: list of IDs to process.
TODO: Rename this method to set_completion_status()
"""
for elemId in elemIds:
if elemId.startswith(SECTION_PREFIX):
Expand Down

0 comments on commit 54354f2

Please sign in to comment.