Skip to content

Commit 069d040

Browse files
author
k8thekat
committed
# conf.py
- Changed conf.py path's to relative. # core.py - Removed un-used imports. - Removed `events` property as I did not want to support them as MC support is changing via the API. # modules.py - Updated docstring for `TriggerID`.
1 parent fb2aad7 commit 069d040

File tree

4 files changed

+10
-13
lines changed

4 files changed

+10
-13
lines changed

ampapi/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
__title__ = "CubeCoders AMP API"
2626
__author__ = "k8thekat"
2727
__license__ = "GNU"
28-
__version__ = "1.0.5"
28+
__version__ = "1.0.6"
2929
__credits__ = "AMP by CubeCoders and associates."
3030

3131
from typing import Literal, NamedTuple
@@ -55,6 +55,6 @@ class VersionInfo(NamedTuple):
5555
releaseLevel: Literal["alpha", "beta", "pre-release", "release", "development"]
5656

5757

58-
version_info: VersionInfo = VersionInfo(Major=1, Minor=0, Revision=5, releaseLevel="release")
58+
version_info: VersionInfo = VersionInfo(Major=1, Minor=0, Revision=6, releaseLevel="release")
5959

6060
del NamedTuple, Literal, VersionInfo

ampapi/core.py

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@
2828
User,
2929
VersionInfo,
3030
)
31-
32-
# from .enums import *
3331
from .modules import TriggerID, UserApplicationData
3432
from .types_ import ActionSpec, APISpec, PermissionNode, ScheduleDataData, TriggersData
3533

@@ -46,17 +44,10 @@ class Core(Base):
4644
4745
Attributes
4846
-----------
49-
events: EventID
50-
You can access all the event IDs an instance has via this attribute. See :class:`EventID` for more information.
5147
triggers: :class:`TriggerID`
5248
You can access all the trigger IDs an instance has via this attribute. See :class:`TriggerID` for more information.
5349
"""
5450

55-
# TODO - Need to finish developing this attribute.
56-
@property
57-
def events(self) -> None:
58-
print()
59-
6051
@property
6152
def triggers(self) -> TriggerID:
6253
try:

ampapi/modules.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,12 @@ def to_dict(self) -> dict[str, Any]:
108108

109109

110110
class TriggerID:
111+
"""
112+
Used for a multitude of functions all related to Triggers and their IDs.
113+
114+
Simply access the respective attribute and the unique GUID for that :class:`AMPInstance` Trigger ID will be returned.
115+
"""
116+
111117
a_backup_finishes_archiving: str
112118
a_backup_finishes_restoring: str
113119
a_backup_has_failed: str

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525

2626
sys.path.insert(0, pathlib.Path("..").as_posix())
2727
sys.path.append(pathlib.Path().as_posix())
28-
sys.path.append(pathlib.Path("docs/extensions").as_posix())
29-
sys.path.append(pathlib.Path("docs/nodes").as_posix())
28+
sys.path.append(pathlib.Path("./docs/extensions").as_posix())
29+
sys.path.append(pathlib.Path("./docs/nodes").as_posix())
3030

3131
extensions = [
3232
"sphinx.ext.autodoc", # Adds support for parsing autoDoc doc-strings.

0 commit comments

Comments
 (0)