diffusers icon indicating copy to clipboard operation
diffusers copied to clipboard

Enhance Documentation with Google Style Docstrings for Export Methods in utils

Open hamza-m-farooqi opened this issue 1 year ago • 3 comments

This PR adds Google style docstrings to export functions (buffered_writer, export_to_gif, export_to_ply, export_to_obj, export_to_video), enhancing documentation clarity and developer understanding. I was working with export_to_video method and I had to peek into the method, so I thought why not write a doc string!!

I have reviewed the contributor guidelines and relevant documentation to ensure alignment with project standards. Eagerly awaiting feedback to refine these docstrings further.

Who can review? Docs: @stevhliu and @sayakpaul

hamza-m-farooqi avatar Mar 28 '24 06:03 hamza-m-farooqi

I don't necessarily think we have to follow Google's style of documentation here. But I will leave it to @stevhliu to decide.

sayakpaul avatar Mar 28 '24 07:03 sayakpaul

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread.

Please note that issues that do not follow the contributing guidelines are likely to be ignored.

github-actions[bot] avatar Apr 27 '24 15:04 github-actions[bot]

Closing because of inactivity. Feel free to reopen.

sayakpaul avatar Jun 30 '24 05:06 sayakpaul