Skip to content

Update docstring function#76

Merged
nabobalis merged 2 commits into
mainfrom
docs
Sep 7, 2022
Merged

Update docstring function#76
nabobalis merged 2 commits into
mainfrom
docs

Conversation

@nabobalis

@nabobalis nabobalis commented Sep 6, 2022

Copy link
Copy Markdown
Member

Trying to fix the docs.

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

Comment thread hvpy/helpers.py
timeout
The timeout in minutes to wait for the movie to be created.
Default is 5 minutes.
{Insert}

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is one way to do it, even tho it is technically in the wrong order.

@nabobalis
nabobalis marked this pull request as ready for review September 6, 2022 15:10
@akash5100

Copy link
Copy Markdown
Collaborator

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

Copy link
Copy Markdown
Member Author

Probably.

@akash5100

Copy link
Copy Markdown
Collaborator

Probably.

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

@nabobalis

Copy link
Copy Markdown
Member Author

Yes that is a problem.

@nabobalis
nabobalis merged commit c0e70a6 into main Sep 7, 2022
@nabobalis
nabobalis deleted the docs branch September 7, 2022 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants