From 50cc135dde7e9a14e017235ca6318a7e478df7a8 Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Sat, 17 Oct 2020 23:46:54 +0200 Subject: [PATCH] Fixed lots of top-of-file docstrings that were out of date --- nw/constants/iso.py | 6 +++--- nw/core/spellcheck.py | 4 ++-- nw/core/tools.py | 15 ++++++++------- nw/error.py | 2 +- nw/gui/custom.py | 8 ++++---- nw/gui/outlinedetails.py | 8 ++++---- nw/gui/preferences.py | 8 ++++---- nw/gui/projload.py | 2 +- nw/gui/projtree.py | 8 ++++---- nw/gui/theme.py | 8 ++++---- 10 files changed, 35 insertions(+), 34 deletions(-) diff --git a/nw/constants/iso.py b/nw/constants/iso.py index 69bd6d23..ccdc0808 100644 --- a/nw/constants/iso.py +++ b/nw/constants/iso.py @@ -1,8 +1,8 @@ # -*- coding: utf-8 -*- -"""novelWriter Language Codes +"""novelWriter ISO Codes - novelWriter – Language Codes -============================== + novelWriter – ISO Codes +========================= Handles translating language codes to language names File History: diff --git a/nw/core/spellcheck.py b/nw/core/spellcheck.py index ff338f62..e3093070 100644 --- a/nw/core/spellcheck.py +++ b/nw/core/spellcheck.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- -"""novelWriter Spell Check Wrapper +"""novelWriter Spell Check Classes - novelWriter – Spell Check Wrapper + novelWriter – Spell Check Classes =================================== Wrapper class for spell checking diff --git a/nw/core/tools.py b/nw/core/tools.py index 8062d591..ef9fbc6b 100644 --- a/nw/core/tools.py +++ b/nw/core/tools.py @@ -1,14 +1,15 @@ # -*- coding: utf-8 -*- -"""novelWriter Word Counter +"""novelWriter Various Tools - novelWriter – Word Counter -============================ - Simple word counter + novelWriter – Various Tools +============================= + Various core tool functions File History: - Created: 2019-04-22 [0.0.1] countWords - Created: 2019-10-13 [0.2.3] numberToWord, _numberToWordEN - Merged: 2020-05-08 [0.4.5] All of the above into this file + Created: 2019-04-22 [0.0.1] countWords + Created: 2019-10-13 [0.2.3] numberToWord, _numberToWordEN + Merged: 2020-05-08 [0.4.5] All of the above into this file + Created: 2020-07-05 [0.10.0] numberToRoman This file is a part of novelWriter Copyright 2018–2020, Veronica Berglyd Olsen diff --git a/nw/error.py b/nw/error.py index a8f3c149..988b49e6 100644 --- a/nw/error.py +++ b/nw/error.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -"""novelWriter Init +"""novelWriter Exception Handling novelWriter – Exception Handling ================================== diff --git a/nw/gui/custom.py b/nw/gui/custom.py index 2955c447..a6260f33 100644 --- a/nw/gui/custom.py +++ b/nw/gui/custom.py @@ -1,9 +1,9 @@ # -*- coding: utf-8 -*- -"""novelWriter Addition QConfigLayout +"""novelWriter Custom Widgets and Layouts - novelWriter – Addition QConfigLayout -====================================== - A custom Qt grid layout for config forms similar to QFormLayout + novelWriter – Custom Widgets and Layouts +========================================== + Various custom widget and layout classes File History: Created: 2020-05-03 [0.4.5] QConfigLayout diff --git a/nw/gui/outlinedetails.py b/nw/gui/outlinedetails.py index 4f6a56f5..18f2b90f 100644 --- a/nw/gui/outlinedetails.py +++ b/nw/gui/outlinedetails.py @@ -1,9 +1,9 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Project Outline +"""novelWriter GUI Project Outline Details - novelWriter – GUI Project Outline -=================================== - Class holding the project outline view + novelWriter – GUI Project Outline Details +=========================================== + Class holding the project outline details view File History: Created: 2020-06-02 [0.7.0] diff --git a/nw/gui/preferences.py b/nw/gui/preferences.py index 2a1cf653..7b8e0905 100644 --- a/nw/gui/preferences.py +++ b/nw/gui/preferences.py @@ -1,9 +1,9 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Config Editor +"""novelWriter GUI Preferences - novelWriter – GUI Config Editor -================================= - Class holding the config dialog + novelWriter – GUI Preferences +=============================== + Class holding the preferences dialog File History: Created: 2019-06-10 [0.1.5] diff --git a/nw/gui/projload.py b/nw/gui/projload.py index 8f18f7bb..29c9c9ab 100644 --- a/nw/gui/projload.py +++ b/nw/gui/projload.py @@ -3,7 +3,7 @@ novelWriter – GUI Open Project ================================ - New and open project dialog + The open project dialog File History: Created: 2020-02-26 [0.4.5] diff --git a/nw/gui/projtree.py b/nw/gui/projtree.py index 6b1ee7bd..77fdf610 100644 --- a/nw/gui/projtree.py +++ b/nw/gui/projtree.py @@ -1,9 +1,9 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Document Tree +"""novelWriter GUI Project Tree - novelWriter – GUI Document Tree -================================= - Class holding the left side document tree view + novelWriter – GUI project Tree +================================ + Class holding the left side project tree view File History: Created: 2018-09-29 [0.0.1] GuiProjectTree diff --git a/nw/gui/theme.py b/nw/gui/theme.py index 5683d1a3..9d907a67 100644 --- a/nw/gui/theme.py +++ b/nw/gui/theme.py @@ -1,9 +1,9 @@ # -*- coding: utf-8 -*- -"""novelWriter Theme Class +"""novelWriter Theme and Icons Classes - novelWriter – Theme Class -=========================== - This class reads and store the main theme + novelWriter – Theme and Icons Classs +====================================== + This class reads and stores the themes and the icons File History: Created: 2019-05-18 [0.1.3] GuiTheme