Fix docstring and rename NWIndex to just Index
This commit is contained in:
@@ -3,9 +3,7 @@ novelWriter – Project Index
|
||||
===========================
|
||||
|
||||
File History:
|
||||
Created: 2019-05-27 [0.1.4] NWIndex
|
||||
Created: 2022-05-28 [2.0rc1] IndexNode
|
||||
Created: 2022-05-28 [2.0rc1] IndexHeading
|
||||
Created: 2019-05-27 [0.1.4] Index
|
||||
Created: 2022-05-29 [2.0rc1] TagsIndex
|
||||
Created: 2022-05-29 [2.0rc1] ItemIndex
|
||||
|
||||
@@ -55,7 +53,7 @@ MAX_RETRY = 1000 # Key generator recursion limit
|
||||
KEY_SOURCE = "0123456789bcdfghjklmnpqrstvwxz"
|
||||
|
||||
|
||||
class NWIndex:
|
||||
class Index:
|
||||
"""Core: Project Index
|
||||
|
||||
This class holds the entire index for a given project. The index
|
||||
@@ -98,7 +96,7 @@ class NWIndex:
|
||||
return
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return f"<NWIndex project='{self._project.data.name}'>"
|
||||
return f"<Index project='{self._project.data.name}'>"
|
||||
|
||||
##
|
||||
# Properties
|
||||
|
||||
@@ -5,9 +5,11 @@ novelWriter – Project Index Data
|
||||
File History:
|
||||
Created: 2022-05-28 [2.0rc1] IndexNode
|
||||
Created: 2022-05-28 [2.0rc1] IndexHeading
|
||||
Moved: 2025-02-22 [2.7b1] IndexNode
|
||||
Moved: 2025-02-22 [2.7b1] IndexHeading
|
||||
|
||||
This file is a part of novelWriter
|
||||
Copyright (C) 2022 Veronica Berglyd Olsen and novelWriter contributors
|
||||
Copyright (C) 2025 Veronica Berglyd Olsen and novelWriter contributors
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
|
||||
@@ -39,7 +39,7 @@ from novelwriter.common import (
|
||||
makeFileNameSafe, minmax
|
||||
)
|
||||
from novelwriter.constants import nwLabels, trConst
|
||||
from novelwriter.core.index import NWIndex
|
||||
from novelwriter.core.index import Index
|
||||
from novelwriter.core.options import OptionState
|
||||
from novelwriter.core.projectdata import NWProjectData
|
||||
from novelwriter.core.projectxml import ProjectXMLReader, ProjectXMLWriter, XMLReadState
|
||||
@@ -75,7 +75,7 @@ class NWProject:
|
||||
self._storage = NWStorage(self) # The project storage handler
|
||||
self._data = NWProjectData(self) # The project settings
|
||||
self._tree = NWTree(self) # The project tree
|
||||
self._index = NWIndex(self) # The project index
|
||||
self._index = Index(self) # The project index
|
||||
self._session = NWSessionLog(self) # The session record
|
||||
|
||||
# Project Status
|
||||
@@ -122,7 +122,7 @@ class NWProject:
|
||||
return self._tree
|
||||
|
||||
@property
|
||||
def index(self) -> NWIndex:
|
||||
def index(self) -> Index:
|
||||
return self._index
|
||||
|
||||
@property
|
||||
|
||||
Reference in New Issue
Block a user