From 3af81276413ae84b8cc175a17e7433e2f9343b2a Mon Sep 17 00:00:00 2001
From: Joshua Fraustro <36318163+jwfraustro@users.noreply.github.com>
Date: Thu, 14 Dec 2023 11:22:50 -0500
Subject: [PATCH] 0.2.1 (#9)

* Update ShortJobDescription class documentation

* Remove unnecessary pylint disable statements in models.py

* bump minor version

* fix package discovery
---
 pyproject.toml          |  6 +-----
 vo_models/uws/models.py | 19 ++++++++++++++++---
 2 files changed, 17 insertions(+), 8 deletions(-)

diff --git a/pyproject.toml b/pyproject.toml
index 1f7f9c4..c6f2fb2 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vo-models"
-version = "0.2.0"
+version = "0.2.1"
 authors = [
     {name = "Joshua Fraustro", email="jfraustro@stsci.edu"},
     {name = "MAST Archive Developers", email="archive@stsci.edu"}
@@ -39,7 +39,3 @@ dev = ["pylint"]
 [project.urls]
 Homepage = "https://github.com/spacetelescope/vo-models"
 Issues = "https://github.com/spacetelescope/vo-models/issues"
-
-[tool.setuptools]
-packages = ["vo_models"]
-
diff --git a/vo_models/uws/models.py b/vo_models/uws/models.py
index 7cac4e4..68ce14f 100644
--- a/vo_models/uws/models.py
+++ b/vo_models/uws/models.py
@@ -122,9 +122,23 @@ class Results(BaseXmlModel, tag="results", ns="uws", nsmap=NSMAP):
 
 
 class ShortJobDescription(BaseXmlModel, tag="jobref", ns="uws", nsmap=NSMAP):
-    """A short description of a job."""
+    """A short description of a job.
 
-    # pylint: disable = no-self-argument
+    Elements:
+    phase (ExecutionPhase):     The execution phase - returned at /{jobs}/{job-id}/phase
+    run_id (str):               A client supplied identifier - the UWS system
+                                does nothing other than to return it as part of the
+                                description of the job
+    owner_id (str):             the owner (creator) of the job - this should be
+                                expressed as a string that can be parsed in accordance
+                                with IVOA security standards.
+    creation_time (datetime):   The instant at which the job was created.
+
+    Attributes:
+    job_id (str):       The identifier for the job.
+    type (XlinkType):   The xlink reference type of the job.
+    href (str):         The link to the job.
+    """
 
     phase: ExecutionPhase = element()
     run_id: Optional[str] = element(tag="runId", default=None)
@@ -198,7 +212,6 @@ class JobSummary(BaseXmlModel, Generic[ParametersType], tag="job", ns="uws", nsm
                             It will be formally required in the next major revision.
     """
 
-    # pylint: disable = no-self-argument
     # pylint: disable = too-few-public-methods
 
     job_id: str = element(tag="jobId")