Skip to content

[modular] auto docstring better format #14350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yiyixuxu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[modular] auto docstring better format #14350

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions src/diffusers/modular_pipelines/modular_pipeline_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -957,14 +957,16 @@ def make_doc_string(
aligned_desc = "\n".join(" " + line.rstrip() for line in desc_lines)
output += aligned_desc + "\n\n"

# Add components section if provided
# Add components section if provided. Keep the blank lines between entries: this string becomes the class
# docstring, which `doc-builder style` reflows, and it merges adjacent description-less single lines (e.g.
# `video_processor (`VideoProcessor`)`) onto one line unless a blank line separates them.
if expected_components and len(expected_components) > 0:
components_str = format_components(expected_components, indent_level=2, add_empty_lines=False)
components_str = format_components(expected_components, indent_level=2, add_empty_lines=True)
output += components_str + "\n\n"

# Add configs section if provided
# Add configs section if provided (blank lines between entries for the same doc-builder reason as above)
if expected_configs and len(expected_configs) > 0:
configs_str = format_configs(expected_configs, indent_level=2, add_empty_lines=False)
configs_str = format_configs(expected_configs, indent_level=2, add_empty_lines=True)
output += configs_str + "\n\n"

# Add inputs section
Expand Down
Loading