Skip to content
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.

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

v1.7.1 - Improper Whitespace Management for :param :/:return: Wrapping #217

Closed
rmartin16 opened this issue May 20, 2023 · 2 comments · Fixed by #219
Closed

v1.7.1 - Improper Whitespace Management for :param :/:return: Wrapping #217

rmartin16 opened this issue May 20, 2023 · 2 comments · Fixed by #219
Labels
C: style Relates to docstring format style (e.g., Google, NumPy, Sphinx) P: bug PEP 257 violation or existing functionality that doesn't work as documented

Comments

@rmartin16
Copy link

With v1.7.1, some of the :param : and :return: wrapping kept a lot of unnecessary whitespace.

Some examples:

@@ -163,9 +163,10 @@ class CreateCommand(BaseCommand):
 
         :param app: The config object for the app
         :return: A dictionary of document types, with the values being dictionaries
-            describing the icon sizes that the template supports. The inner dictionary
-            describes the path fragments (relative to the bundle path) for the images
-            that are required; the keys are the size of the splash images.
+                describing the icon sizes that the template supports. The inner
+                dictionary             describes the path fragments (relative to the
+                bundle path) for the images             that are required; the keys are
+                the size of the splash images.
         """
@@ -127,8 +127,9 @@ class BaseCommand(ABC):
         :param apps: Dictionary of project's Apps keyed by app name.
         :param base_path: Base directory for Briefcase project.
         :param data_path: Base directory for Briefcase tools, support packages, etc.
-        :param is_clone: Flag that Command was triggered by the user's requested Command;
-            for instance, RunCommand can invoke UpdateCommand and/or BuildCommand.
+        :param is_clone: Flag that Command was triggered by the user's requested
+                Command;             for instance, RunCommand can invoke UpdateCommand
+                and/or BuildCommand.
         """
         if base_path is None:
@@ -512,8 +512,8 @@ connection.
     def verify_system_image(self, system_image):
         """Verify that the required system image is installed.
 
-        :param system_image: The SDKManager identifier for the system
-            image (e.g., ``"system-images;android-31;default;x86_64"``)
+        :param system_image: The SDKManager identifier for the system             image
+                (e.g., ``"system-images;android-31;default;x86_64"``)
         """
         # Look for the directory named as a system image.
         # If it exists, we already have the system image.
@@ -1040,8 +1040,8 @@ In future, you can specify this device by running:
         """Update the AVD configuration with specific values.
 
         :params avd: The AVD whose config will be updated
-        :params updates: A dictionary containing the new key-value to
-            add to the device configuration.
+        :params updates: A dictionary containing the new key-value to             add to
+                the device configuration.
         """
         avd_config = self.avd_config(avd)

Config:

  - repo: https://github.com/PyCQA/docformatter
    rev: v1.7.1
    hooks:
      - id: docformatter
        args: [--in-place, --black]
@github-actions github-actions bot added the fresh This is a new issue label May 20, 2023
@weibullguy
Copy link
Member

I can't reproduce these. Could you post a link to the PR or the file this docstring is in so I can make sure I'm using your whole docstring?

@weibullguy weibullguy added P: bug PEP 257 violation or existing functionality that doesn't work as documented C: style Relates to docstring format style (e.g., Google, NumPy, Sphinx) S: feedback Open but need feedback from OP to proceed with solution and removed fresh This is a new issue labels May 21, 2023
@rmartin16
Copy link
Author

rmartin16 commented May 21, 2023

Could you post a link to the PR or the file this docstring is in so I can make sure I'm using your whole docstring?

Sure thing; the scheduled CI finally ran for this today: beeware/briefcase#1281

https://github.com/beeware/briefcase/pull/1281/files

@weibullguy weibullguy removed the S: feedback Open but need feedback from OP to proceed with solution label May 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: style Relates to docstring format style (e.g., Google, NumPy, Sphinx) P: bug PEP 257 violation or existing functionality that doesn't work as documented
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants