Repository navigation
Wrapping doesn't work at all when there is an argument list? #174
Description
Activity
+1, docformatter is wrapping summaries nicely for me but not descriptions (i.e. the paragraph under the summary):
docformatter \ --wrap-summaries 120 \ --wrap-descriptions 120 \ --in-place \ --pre-summary-newline \ --close-quotes-on-newline \ --recursive \ .This second line should be reformatted into a small paragraph but is not:
""" Initializes a new model and infers the task type from the model definitions. This method creates a new model instance based on the provided configuration file. It loads the model configuration, infers the task type if not specified, and initializes the model using the appropriate class from the task map. Parameters: cfg (str): Path to the model configuration file in YAML format. task (str | None): The specific task for the model. If None, it will be inferred from the config. model (torch.nn.Module | None): A custom model instance. If provided, it will be used instead of creating a new one. verbose (bool): If True, displays model information during loading. Raises: ValueError: If the configuration file is invalid or the task cannot be inferred. ImportError: If the required dependencies for the specified task are not installed. Examples: >>> model = Model() >>> model._new('yolov8n.yaml', task='detect', verbose=True) """
I made a super sketchy script that can wrap argument lists here! https://github.com/btjanaka/wrap-docstrings It's pretty limited in that it assumes your docstrings are already google style and there are probably edge cases I didn't account for, but it worked on the code I was using. See the README for some examples of what it can do.
- added a commit that references this issue
on Oct 2, 2025 I have been using a solution that gets around this and I have just raised a PR (#381) incorporating that solution, so it can hopefully address it appropriately. I request someone to please review and approve it.
#324 already restores wrapping of the prose before Args: / Returns:, but it leaves those sections unchanged. The new PR wraps each Args/Returns entry as its own unit, keeps the Google structure, and is idempotent.
I may be ignorant or missing something. Here are some examples:
Running docformatter on the above does nothing, unless I specify
--force-wrapwhich does what I want for the long line, but botches the argument list:Compare to what happens if I remove the lists, and also remove
--force-wrap:Is wrapping all or nothing; if there are lists no lines get wrapped? Or are my arg/returns lists malformed? Any insight is appreciated!