-
-
Notifications
You must be signed in to change notification settings - Fork 347
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
Normalize usage of newlines. #1769
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question about the vertical spacing.
Also, do you think the logging API might benefit from extra optional parameters that can insert vertical space before and after the content to log? This is a common pattern.
src/briefcase/commands/create.py
Outdated
if getattr(app, "splash", None): | ||
self.logger.warning() | ||
self.logger.warning( | ||
"\nSplash screens are now configured based on the icon. " | ||
"The splash configuration will be ignored.\n" | ||
"Splash screens are now configured based on the icon. " | ||
"The splash configuration will be ignored." | ||
) | ||
|
||
self.logger.info() | ||
for extension, doctype in self.document_type_icon_targets(app).items(): | ||
for size, target in doctype.items(): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure I understand this empty info()
call. Do we always want space here?
In most cases, we'll just get an extra line before the next step.
Without splash
in pyproject.toml
:
Installing app requirements... done
[helloworld] Installing application resources...
Unable to find src/helloworld/resources/helloworld-16.png for 16px application icon; using default
Unable to find src/helloworld/resources/helloworld-32.png for 32px application icon; using default
Unable to find src/helloworld/resources/helloworld-64.png for 64px application icon; using default
Unable to find src/helloworld/resources/helloworld-128.png for 128px application icon; using default
Unable to find src/helloworld/resources/helloworld-256.png for 256px application icon; using default
Unable to find src/helloworld/resources/helloworld-512.png for 512px application icon; using default
[helloworld] Removing unneeded app content...
Removing unneeded app bundle content... done
[helloworld] Created build/helloworld/pop/jammy
With splash
in pyproject.toml
:
Installing app requirements... done
[helloworld] Installing application resources...
Unable to find src/helloworld/resources/helloworld-16.png for 16px application icon; using default
Unable to find src/helloworld/resources/helloworld-32.png for 32px application icon; using default
Unable to find src/helloworld/resources/helloworld-64.png for 64px application icon; using default
Unable to find src/helloworld/resources/helloworld-128.png for 128px application icon; using default
Unable to find src/helloworld/resources/helloworld-256.png for 256px application icon; using default
Unable to find src/helloworld/resources/helloworld-512.png for 512px application icon; using default
Splash screens are now configured based on the icon. The splash configuration will be ignored.
[helloworld] Removing unneeded app content...
Removing unneeded app bundle content... done
[helloworld] Created build/helloworld/pop/jammy
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Dang... the intention was to put a single break between the app icons and the document icons... but I forgot about the "there aren't any document icons" case. Fix incoming.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've opted to put the blank inside the outer loop; that means there will be a line break between the app icons and the first document icon (if there is one), and a break between each document icon group.
changes/1769.misc.rst
Outdated
@@ -0,0 +1 @@ | |||
The usage of newlines in a message was modified to be consistent with line autosplitting. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FWIW, the Sphinx spell checker won't like autosplitting
....but I think that won't matter since this is a misc
note...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It will still bite my ass when I do the release on Monday, so I'll fix it now :-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good
#1766 included a newline cleanup that isn't entirely compatible with the line splitting approach being used.
PR Checklist: