Skip to content

Commit

Permalink
0.2.1 (#9)
Browse files Browse the repository at this point in the history
* Update ShortJobDescription class documentation

* Remove unnecessary pylint disable statements in models.py

* bump minor version

* fix package discovery
  • Loading branch information
jwfraustro authored Dec 14, 2023
1 parent 3549a59 commit 3af8127
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
6 changes: 1 addition & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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="[email protected]"},
{name = "MAST Archive Developers", email="[email protected]"}
Expand Down Expand Up @@ -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"]

19 changes: 16 additions & 3 deletions vo_models/uws/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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")
Expand Down

0 comments on commit 3af8127

Please sign in to comment.