Reproog/novelWriter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Reformat and update the source file header docstrings

Browse Source
This commit is contained in:
Veronica K. B. Olsen
2021-01-16 17:41:40 +01:00
parent e7e2176e64
commit cdf3c62d17
39 changed files with 719 additions and 758 deletions
Download Patch File Download Diff File Expand all files Collapse all files
nw/common.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter Common Functions
"""
novelWriter – Common Functions
================================
Various functions used multiple places
==============================
Various common functions
File History:
Created: 2019-05-12 [0.1.0]
nw/config.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter Config Class
"""
novelWriter – Config Class
============================
Class reading and holding the preferences of the application
==========================
Class holding the user preferences and handling the config file
File History:
Created: 2018-09-22 [0.0.1]
nw/constants/constants.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter Constants
"""
novelWriter – Constants
=========================
Constants for translating flags and enums to text
=======================
Constants and maps for translating flags and enums to text
File History:
Created: 2019-04-28 [0.0.1]
nw/constants/enum.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter Enums
"""
novelWriter – Enums
=====================
All enum values
===================
Global enum values
File History:
Created: 2018-11-02 [0.0.1]
nw/constants/iso.py
+2 -3
View File
@@ -1,8 +1,7 @@
# -*- coding: utf-8 -*-
"""novelWriter ISO Codes
"""
novelWriter – ISO Codes
=========================
=======================
Handles translating language codes to language names
File History:
nw/core/document.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter Project Document
"""
novelWriter – Project Document
================================
Class holding a single novelWriter document
==============================
Data class for a single novelWriter document
File History:
Created: 2018-09-29 [0.0.1]
nw/core/index.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter Project Index
"""
novelWriter – Project Index
=============================
Class holding the project index of tags, headers and references
===========================
Data class for the project index of tags, headers and references
File History:
Created: 2019-05-27 [0.1.4]
nw/core/item.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter Project Item Class
"""
novelWriter – Project Item Class
==================================
Class holding the data of a project tree item
================================
Data class for a project tree item
File History:
Created: 2018-10-27 [0.0.1]
nw/core/options.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter Project Options Cache
"""
novelWriter – Project Options Cache
=====================================
Class wrapping the project options state
===================================
Data class for user-defined GUI project options
File History:
Created: 2019-10-21 [0.3.1]
nw/core/project.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter Project Wrapper
"""
novelWriter – Project Wrapper
===============================
Class wrapping the data of a novelWriter project
=============================
Data class for novelWriter projects
File History:
Created: 2018-09-29 [0.0.1]
nw/core/spellcheck.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter Spell Check Classes
"""
novelWriter – Spell Check Classes
===================================
Wrapper class for spell checking tools
=================================
Wrapper classes for spell checking tools
File History:
Created: 2019-06-11 [0.1.5]
nw/core/status.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter Project Item Status Class
"""
novelWriter – Project Item Status Class
=========================================
Class holding the status/importance elements of a project item
=======================================
Data class for the status/importance settings of a project item
File History:
Created: 2019-05-19 [0.1.3]
nw/core/tohtml.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter HTML Text Converter
"""
novelWriter – HTML Text Converter
===================================
Extends the Tokenizer class to write HTML
=================================
Extends the Tokenizer class to generate HTML output
File History:
Created: 2019-05-07 [0.0.1]
nw/core/tokenizer.py
+2 -3
View File
@@ -1,8 +1,7 @@
# -*- coding: utf-8 -*-
"""novelWriter Text Tokenizer
"""
novelWriter – Text Tokenizer
==============================
============================
Splits a piece of novelWriter markdown text into its elements
File History:
nw/core/tools.py
+2 -3
View File
@@ -1,8 +1,7 @@
# -*- coding: utf-8 -*-
"""novelWriter Various Tools
"""
novelWriter – Various Tools
=============================
===========================
Various core tool functions
File History:
nw/core/tree.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter Project Tree Class
"""
novelWriter – Project Tree Class
==================================
Class holding the project's tree of project items
================================
Data class for the project's tree of project items
File History:
Created: 2020-05-07 [0.4.5]
nw/error.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter Exception Handling
"""
novelWriter – Exception Handling
==================================
Error handling functions
================================
Error handling function and error dialog
File History:
Created: 2020-08-02 [0.10.2]
nw/gui/about.py
+2 -3
View File
@@ -1,8 +1,7 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI About Box
"""
novelWriter – GUI About Box
=============================
===========================
The about novelWriter dialog box
File History:
nw/gui/build.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Build Novel Project
"""
novelWriter – GUI Build Novel Project
=======================================
Class holding the build novel project dialog
=====================================
GUI classes for the build novel project dialog
File History:
Created: 2020-05-09 [0.5]
nw/gui/custom.py
+2 -3
View File
@@ -1,8 +1,7 @@
# -*- coding: utf-8 -*-
"""novelWriter Custom Widgets and Layouts
"""
novelWriter – Custom Widgets and Layouts
==========================================
========================================
Various custom widget and layout classes
File History:
nw/gui/doceditor.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Document Editor
"""
novelWriter – GUI Document Editor
===================================
Class holding the main document editor
=================================
GUI classes for the main document editor
File History:
Created: 2018-09-29 [0.0.1] GuiDocEditor
nw/gui/dochighlight.py
+4 -5
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Document Highlighter
novelWriter – GUI Document Highlighter
========================================
Subclass for the main editor syntax highlighting
"""
novelWriter – GUI Syntax Highlighter
====================================
Class for the main document editor syntax highlighter
File History:
Created: 2019-04-06 [0.0.1]
nw/gui/docmerge.py
+4 -5
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Doc Merge
novelWriter – GUI Doc Merge
=============================
Tool for merging multiple documents to one document
"""
novelWriter – GUI Doc Merge Tool
================================
GUI class for merging multiple documents to one document
File History:
Created: 2020-01-23 [0.4.3]
nw/gui/docsplit.py
+4 -5
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Doc Split
novelWriter – GUI Doc Split
=============================
Tool for splitting a single document into multiple documents
"""
novelWriter – GUI Doc Split Tool
================================
GUI class for splitting a single document into multiple documents
File History:
Created: 2020-02-01 [0.4.3]
nw/gui/docviewer.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Document Viewer
"""
novelWriter – GUI Document Viewer
===================================
Class holding the main document viewer
=================================
GUI classes for the main document viewer
File History:
Created: 2019-05-10 [0.0.1] GuiDocViewer
nw/gui/itemdetails.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Document Details
novelWriter – GUI Document Details
"""
novelWriter – GUI Item Details Panel
====================================
Class holding the project tree item details panel
GUI class for the project tree item details panel
File History:
Created: 2019-04-24 [0.0.1]
nw/gui/itemeditor.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Item Editor
"""
novelWriter – GUI Item Editor
===============================
Class holding the item editor dialog
=============================
GUI class for the item editor dialog
File History:
Created: 2019-04-27 [0.0.1]
nw/gui/mainmenu.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Main Menu
"""
novelWriter – GUI Main Menu
=============================
Class holding the main window menu
===========================
GUI class for the main window menu
File History:
Created: 2019-04-27 [0.0.1]
nw/gui/outline.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Project Outline
"""
novelWriter – GUI Project Outline
===================================
Class holding the project outline view
=================================
GUI class for the project outline view
File History:
Created: 2019-11-16 [0.4.1]
nw/gui/outlinedetails.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Project Outline Details
"""
novelWriter – GUI Project Outline Details
===========================================
Class holding the project outline details panel
=========================================
GUI class for the project outline details panel
File History:
Created: 2020-06-02 [0.7.0]
nw/gui/preferences.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Preferences
"""
novelWriter – GUI Preferences
===============================
Class holding the preferences dialog
=============================
GUI classes for the user preferences dialog
File History:
Created: 2019-06-10 [0.1.5]
nw/gui/projload.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Open Project
"""
novelWriter – GUI Open Project
================================
Class holding the load/browse/new project dialog
==============================
GUI class for the load/browse/new project dialog
File History:
Created: 2020-02-26 [0.4.5]
nw/gui/projsettings.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Project Settings
"""
novelWriter – GUI Project Settings
====================================
Class holding the project settings dialog
==================================
GUI classes for the project settings dialog
File History:
Created: 2018-09-29 [0.0.1]
nw/gui/projtree.py
+4 -5
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Project Tree
novelWriter – GUI project Tree
================================
Class holding the project tree view
"""
novelWriter – GUI Project Tree
==============================
GUI classes for the main window project tree
File History:
Created: 2018-09-29 [0.0.1] GuiProjectTree
nw/gui/projwizard.py
+4 -5
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI New Project Wizard
novelWriter – GUI New project Wizard
======================================
Class holding the new project wizard dialog
"""
novelWriter – GUI New Project Wizard
====================================
GUI classes for the new project wizard dialog
File History:
Created: 2020-07-11 [0.10.1]
nw/gui/statusbar.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Main Window StatusBar
"""
novelWriter – GUI Main Window Status Bar
=========================================
Class holding the main window status bar
========================================
GUI class for the main window status bar
File History:
Created: 2019-04-20 [0.0.1]
nw/gui/theme.py
+4 -5
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter Theme and Icons Classes
novelWriter – Theme and Icons Classs
======================================
Class managing and caching themes and icons
"""
novelWriter – Theme and Icons Classes
=====================================
Classes managing and caching themes and icons
File History:
Created: 2019-05-18 [0.1.3] GuiTheme
nw/gui/writingstats.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Writing Statistics
"""
novelWriter – GUI Writing Statistics
======================================
Class holding the word count and session statistics dialog
====================================
GUI class for the session statistics dialog
File History:
Created: 2019-10-20 [0.3]
nw/guimain.py
+3 -4
View File
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-
"""novelWriter GUI Main Window
"""
novelWriter – GUI Main Window
===============================
Class holding the main application window
=============================
The main application window
File History:
Created: 2018-09-22 [0.0.1]