Skip to content

Commit c0e70a6

Browse files
author
Nabil Freij
authored
Update docstring function (#76)
1 parent d1b872a commit c0e70a6

18 files changed

+61
-37
lines changed

‎hvpy/api_groups/communications/get_news_feed.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,18 @@ class getNewsFeedInputParameters(HvpyParameters):
77
"""
88
Handles the input parameters of the ``getNewsFeed`` API.
99
10+
.. {Shared}
1011
Attributes
1112
----------
12-
{Shared}
1313
callback
1414
Wrap the response object in a function call of your choosing.
1515
Default is `None` (no wrapping), optional.
1616
1717
References
1818
----------
1919
* `<https://api.helioviewer.org/docs/v2/api/api_groups/web_site.html#getnewsfeed>`__
20-
{Shared}
20+
21+
.. {Shared}
2122
"""
2223

2324
callback: Optional[str] = None

‎hvpy/api_groups/communications/shorten_url.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ class shortenURLInputParameters(HvpyParameters):
77
"""
88
Handles the input parameters of the ``shortenURL`` API.
99
10+
.. {Shared}
1011
Attributes
1112
----------
12-
{Shared}
1313
queryString
1414
The URL-encoded query string.
1515
callback
@@ -19,7 +19,8 @@ class shortenURLInputParameters(HvpyParameters):
1919
References
2020
----------
2121
* `<https://api.helioviewer.org/docs/v2/api/api_groups/official_clients.html#shortenurl>`__
22-
{Shared}
22+
23+
.. {Shared}
2324
"""
2425

2526
queryString: str

‎hvpy/api_groups/jpeg2000/get_jp2_header.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ class getJP2HeaderInputParameters(HvpyParameters):
77
"""
88
Handles the input parameters of the ``getJP2Header`` API.
99
10+
.. {Shared}
1011
Attributes
1112
----------
12-
{Shared}
1313
id
1414
Unique JP2 image identifier.
1515
callback
@@ -19,7 +19,8 @@ class getJP2HeaderInputParameters(HvpyParameters):
1919
References
2020
----------
2121
* `<https://api.helioviewer.org/docs/v2/api/api_groups/jpeg2000.html#getjp2header>`__
22-
{Shared}
22+
23+
.. {Shared}
2324
"""
2425

2526
id: int

‎hvpy/api_groups/jpeg2000/get_jp2_image.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ class getJP2ImageInputParameters(HvpyParameters):
1010
"""
1111
Handles the input parameters of the ``getJP2Image`` API.
1212
13+
.. {Shared}
1314
Attributes
1415
----------
15-
{Shared}
1616
date
1717
Desired datetime of the JP2 image.
1818
sourceId
@@ -27,7 +27,8 @@ class getJP2ImageInputParameters(HvpyParameters):
2727
References
2828
----------
2929
* `<https://api.helioviewer.org/docs/v2/api/api_groups/jpeg2000.html#getjp2image>`__
30-
{Shared}
30+
31+
.. {Shared}
3132
"""
3233

3334
date: datetime

‎hvpy/api_groups/jpeg2000/get_jpx.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ class getJPXInputParameters(HvpyParameters):
1111
"""
1212
Handles the input parameters of the ``getJPX`` API.
1313
14+
.. {Shared}
1415
Attributes
1516
----------
16-
{Shared}
1717
startTime
1818
Datetime for the beginning of the JPX movie data.
1919
endTime
@@ -38,7 +38,8 @@ class getJPXInputParameters(HvpyParameters):
3838
References
3939
----------
4040
* `<https://api.helioviewer.org/docs/v2/api/api_groups/jpeg2000.html#getjpx>`__
41-
{Shared}
41+
42+
.. {Shared}
4243
"""
4344

4445
startTime: datetime

‎hvpy/api_groups/jpeg2000/get_jpx_closest_to_mid_point.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ class getJPXClosestToMidPointInputParameters(HvpyParameters):
1111
"""
1212
Handles the input parameters of the ``getJPXClosestToMidPoint`` API.
1313
14+
.. {Shared}
1415
Attributes
1516
----------
16-
{Shared}
1717
startTimes
1818
A list of datetimes for the beginning of the JPX movie data.
1919
endTimes
@@ -33,7 +33,8 @@ class getJPXClosestToMidPointInputParameters(HvpyParameters):
3333
References
3434
----------
3535
* `<https://api.helioviewer.org/docs/v2/api/api_groups/jpeg2000.html#getjpxclosesttomidpoint>`__
36-
{Shared}
36+
37+
.. {Shared}
3738
"""
3839

3940
startTimes: List[datetime]

‎hvpy/api_groups/jpeg2000/get_status.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@ class getStatusInputParameters(HvpyParameters):
55
"""
66
Handles the input parameters of the ``getStatus`` API.
77
8-
{Shared}
8+
.. {Shared}
99
References
1010
----------
1111
* `<https://api.helioviewer.org/docs/v2/api/api_groups/jpeg2000.html#getstatus>`__
12-
{Shared}
12+
13+
.. {Shared}
1314
"""
1415

1516
def get_output_type(self) -> OutputType:

‎hvpy/api_groups/movies/download_movie.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ class downloadMovieInputParameters(HvpyParameters):
55
"""
66
Handles the input parameters of the ``downloadMovie`` API.
77
8+
.. {Shared}
89
Attributes
910
----------
10-
{Shared}
1111
id
1212
Unique movie identifier, returned as a response by the ``queueMovie`` endpoint request.
1313
format
@@ -19,7 +19,8 @@ class downloadMovieInputParameters(HvpyParameters):
1919
References
2020
----------
2121
* `<https://api.helioviewer.org/docs/v2/api/api_groups/movies.html#id9>`__
22-
{Shared}
22+
23+
.. {Shared}
2324
"""
2425

2526
id: str

‎hvpy/api_groups/movies/get_movie_status.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ class getMovieStatusInputParameters(HvpyParameters):
99
1010
Attributes
1111
----------
12-
{Shared}
12+
.. {Shared}
1313
id
1414
Unique movie identifier, returned as a response by the ``queueMovie`` endpoint request.
1515
format
@@ -27,7 +27,8 @@ class getMovieStatusInputParameters(HvpyParameters):
2727
References
2828
----------
2929
* `<https://api.helioviewer.org/docs/v2/api/api_groups/movies.html#id8>`__
30-
{Shared}
30+
31+
.. {Shared}
3132
"""
3233

3334
id: str

‎hvpy/api_groups/movies/queue_movie.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ class queueMovieInputParameters(HvpyParameters):
1111
"""
1212
Handles the input parameters of the ``queueMovie`` API.
1313
14+
.. {Shared}
1415
Attributes
1516
----------
16-
{Shared}
1717
startTime
1818
Datetime of the first frame of the movie.
1919
endTime
@@ -102,7 +102,8 @@ class queueMovieInputParameters(HvpyParameters):
102102
References
103103
----------
104104
* `<https://api.helioviewer.org/docs/v2/api/api_groups/movies.html#queuemovie>`__
105-
{Shared}
105+
106+
.. {Shared}
106107
"""
107108

108109
startTime: datetime

0 commit comments

Comments
 (0)