Skip to content

Commit 7a0ff70

Browse files
committed
docs: describe what the parallel debug flag actually controls
- GetPageParam, UploadPageParam and DeletePageParam - the flag is only read as parallelize(flush_at_end=...) - it keeps or discards the messages the workers already logged - warnings and errors are written out either way
1 parent 96e6be2 commit 7a0ff70

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

‎src/osw/wtsite.py‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,9 @@ class GetPageParam(OswBaseModel):
352352
retry_delay_s: Optional[int] = 5
353353
"""Retry delay in seconds"""
354354
debug: Optional[bool] = False
355-
"""Whether to log debug messages"""
355+
"""Only has an effect when parallel is True. If True, the messages logged
356+
while the pages are fetched are written out once the batch has finished.
357+
If False, only warnings and errors are written out."""
356358
raise_exception: Optional[bool] = False
357359
"""Whether to raise an exception if an error occurs"""
358360
raise_warning: Optional[bool] = True
@@ -667,7 +669,9 @@ class UploadPageParam(OswBaseModel):
667669
parallel: Optional[bool] = False
668670
"""If True, uploads the pages in parallel."""
669671
debug: Optional[bool] = False
670-
"""If True, debug messages will be logged."""
672+
"""Only has an effect when parallel is True. If True, the messages logged
673+
while the pages are uploaded are written out once the batch has finished.
674+
If False, only warnings and errors are written out."""
671675
comment: Optional[str] = None
672676
"""Edit comment for the page history, applied to every uploaded page."""
673677

@@ -783,7 +787,9 @@ class DeletePageParam(OswBaseModel):
783787
page: Union["WtPage", List["WtPage"], str, List[str]]
784788
comment: Optional[str] = None
785789
debug: Optional[bool] = True
786-
"""If True, debug messages will be logged."""
790+
"""Only has an effect when parallel is True. If True, the messages logged
791+
while the pages are deleted are written out once the batch has finished.
792+
If False, only warnings and errors are written out."""
787793
parallel: Optional[bool] = None
788794
"""If true, processes the pages in parallel."""
789795

0 commit comments

Comments
 (0)