Skip to content

Commit 2a69f50

Browse files
author
Neefs, Jef
committed
adding version to documentation to help out on #1016
1 parent 4355170 commit 2a69f50

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

docs/api.rst

+5
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ Comment
2626

2727
.. autoclass:: Comment
2828

29+
Version
30+
=======
31+
32+
.. autoclass:: jira.resources.Version
33+
2934
Worklog
3035
=======
3136

jira/resources.py

+11-4
Original file line numberDiff line numberDiff line change
@@ -879,10 +879,11 @@ def __init__(self, options, session, raw=None):
879879
self._parse_raw(raw)
880880

881881
def delete(self, moveFixIssuesTo=None, moveAffectedIssuesTo=None):
882-
"""Delete this project version from the server.
882+
"""
883+
Delete this project version from the server.
883884
884-
If neither of the arguments are specified, the version is
885-
removed from all issues it is attached to.
885+
If neither of the arguments are specified, the version is removed from all
886+
issues it is attached to.
886887
887888
:param moveFixIssuesTo: in issues for which this version is a fix
888889
version, add this argument version to the fix version list
@@ -899,7 +900,13 @@ def delete(self, moveFixIssuesTo=None, moveAffectedIssuesTo=None):
899900
return super(Version, self).delete(params)
900901

901902
def update(self, **args):
902-
"""Update this project version from the server. It is prior used to archive versions."""
903+
"""
904+
Update this project version from the server. It is prior used to archive versions.
905+
906+
link to atlassian restapi `documentation`_.
907+
908+
.. _doc: https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-project-versions/#api-rest-api-2-version-id-get
909+
"""
903910
data = {}
904911
for field in args:
905912
data[field] = args[field]

0 commit comments

Comments
 (0)