Skip to content

Commit 7c10484

Browse files
cppartsbmatthieu3
authored andcommitted
updating setters to have relevant doc strings
1 parent 0d8743e commit 7c10484

1 file changed

Lines changed: 20 additions & 10 deletions

File tree

src/ipyaladin/widget.py

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,7 @@ def height(self) -> int:
293293

294294
@height.setter
295295
def height(self, height: int) -> None:
296+
"""Height can be set with integer representing number of pixels."""
296297
if np.isclose(self._height, height):
297298
return
298299
self._wcs = {}
@@ -308,9 +309,6 @@ def rotation(self) -> float:
308309
Positive angles rotates the view in the counter clockwise
309310
order (or towards the east).
310311
311-
It can be set with either a float number in degrees
312-
or an astropy.coordinates.Angle object.
313-
314312
Returns
315313
-------
316314
astropy.coordinates.Angle
@@ -322,6 +320,12 @@ def rotation(self) -> float:
322320

323321
@rotation.setter
324322
def rotation(self, rotation: Union[float, Angle]) -> None:
323+
"""
324+
Rotation can be set with view center to north pole angle in degrees.
325+
326+
Rotation can either a float number in degrees
327+
or an `~astropy.coordinates.Angle` object.
328+
"""
325329
if isinstance(rotation, Angle):
326330
rotation = rotation.deg
327331
if np.isclose(self._rotation, rotation):
@@ -383,9 +387,6 @@ def fov_xy(self) -> Tuple[Angle, Angle]:
383387
def fov(self) -> Angle:
384388
"""The field of view of the Aladin Lite widget along the horizontal axis.
385389
386-
It can be set with either a float number in degrees
387-
or an astropy.coordinates.Angle object.
388-
389390
Returns
390391
-------
391392
astropy.coordinates.Angle
@@ -400,6 +401,12 @@ def fov(self) -> Angle:
400401

401402
@fov.setter
402403
def fov(self, fov: Union[float, Angle]) -> None:
404+
"""
405+
FoV can be set with angle representing horizontal axis.
406+
407+
FoV can be set with either a float number in degrees
408+
or an `~astropy.coordinates.Angle` object.
409+
"""
403410
if isinstance(fov, Angle):
404411
fov = fov.deg
405412
if np.isclose(fov, self._fov):
@@ -413,10 +420,6 @@ def fov(self, fov: Union[float, Angle]) -> None:
413420
def target(self) -> Union[SkyCoord, Tuple[float, float]]:
414421
"""The target of the Aladin Lite widget.
415422
416-
The target can be provided as coordinates (either
417-
`~astropy.coordinates.SkyCoord` or (`~astropy.coordinates.Longitude`,
418-
`~astropy.coordinates.Latitude`)) or as a name (as a string).
419-
420423
The conversion from a name to coordinates does call different online services
421424
depending on the base layer of the widget:
422425
- for the sky: it uses CDS's
@@ -451,6 +454,13 @@ def target(self) -> Union[SkyCoord, Tuple[float, float]]:
451454

452455
@target.setter
453456
def target(self, target: Union[str, SkyCoord, Tuple[float, float]]) -> None:
457+
"""
458+
Target can be set using coordinates or name.
459+
460+
Target can be provided as coordinates (either
461+
`~astropy.coordinates.SkyCoord` or (`~astropy.coordinates.Longitude`,
462+
`~astropy.coordinates.Latitude`)) or as a name (as a string).
463+
"""
454464
if isinstance(target, Tuple):
455465
lon, lat = target[0].deg, target[1].deg
456466
elif isinstance(target, str): # If the target is a string, parse it

0 commit comments

Comments
 (0)