Helioviewer-Project / python-api

Python wrapper around the Helioviewer API.
https://hvpy.readthedocs.io/en/latest/
BSD 2-Clause "Simplified" License
6 stars 5 forks source link

Update docstring function #76

Closed nabobalis closed 1 year ago

nabobalis commented 1 year ago

Trying to fix the docs.

Changed from shared to a comment so avoid it showing up in the rst pages.

akash5100 commented 1 year ago

In the createMovie function:

def createMovie(
    startTime: datetime,
    endTime: datetime,
    layers: str,
    events: str,
    eventsLabels: bool,
    imageScale: float,
    format: Optional[str] = "mp4",
    frameRate: Optional[str] = "15",
    maxFrames: Optional[str] = None,
    scale: Optional[bool] = None,
    scaleType: Optional[str] = None,
    scaleX: Optional[float] = None,
    scaleY: Optional[float] = None,
    movieLength: Optional[float] = None,
    watermark: Optional[bool] = True,
    width: Optional[str] = None,
    height: Optional[str] = None,
    x0: Optional[str] = None,
    y0: Optional[str] = None,
    x1: Optional[str] = None,
    y1: Optional[str] = None,
    x2: Optional[str] = None,
    y2: Optional[str] = None,
    size: Optional[int] = None,
    movieIcons: Optional[int] = None,
    followViewport: Optional[int] = None,
    reqObservationDate: Optional[datetime] = None,
    overwrite: bool = False,
    filename: Union[str, Path] = None,
    hq: bool = False,
    timeout: float = 5,
) -> Path:

The callback argument(which is in queueMovie) returns the string response. We only want to write binary data in the createMovie function. So to eliminate the option of returning str, I removed the callback argument. I did right?

nabobalis commented 1 year ago

Probably.

akash5100 commented 1 year ago

Probably.

So if we copy docstring, it will copy callback too. That is the problem.

nabobalis commented 1 year ago

Yes that is a problem.