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 - Quoted URL String Broken by Line Length Leaving Quote on Previous Line #218

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

v1.7.1 - Quoted URL String Broken by Line Length Leaving Quote on Previous Line #218

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, encountered a case of a quoted string at the line length being broken leaving the quote on the previous line.

Maybe the fact it's a URL is playing a role here...

     def make_project_url(self, bundle, app_name):
         """Construct a candidate project URL from the bundle and app name.
 
-        It's not a perfect guess, but it's better than having
-        "https://example.com".
+        It's not a perfect guess, but it's better than having "
+        https://example.com".
 
         :param bundle: The bundle identifier.
         :param app_name: The app name.

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 this one, I get:

-    It's not a perfect guess, but it's better than having
-    "https://example.com".
+    It's not a perfect guess, but it's better than having "https://example.com".

Could you post a link to the PR or the file this docstring is in so I can make sure I'm using the 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 the your whole docstring?

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

https://github.com/beeware/briefcase/pull/1281/files#diff-d538de51047cebe61e3d51b1b421d2a126c262b04bef94302b97a68bfe3fe854L198

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