Skip to content

Update inline descriptions for DartCode settings - #2930

Merged
DanTup merged 2 commits into
Dart-Code:masterfrom
timsneath:master
Nov 4, 2020
Merged

DanTup merged 2 commits into
Dart-Code:masterfrom
timsneath:master

Conversation

@timsneath

@timsneath timsneath commented Nov 3, 2020 •

Copy link
Copy Markdown
Contributor

It's election day and I can't focus on complicated tasks today, so I'm investing some time in tidy-up work instead.

This pull request attempts to clean up some of the settings descriptions for the extension:

  • Uses markdownDescription where appropriate to add hyperlinks and code fences
  • Replaces "folder" with "directory"; "application" with "app" per Google developer style guide
  • A few minor grammar nits or clarifications where I believed they improved the text

I've tested this locally by running in the extension development host to make sure the changes are presented correctly in launch.json and the settings editor.

@DanTup DanTup left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! This all looks good to me. I'd somehow missed markdownDescription and it'd always bugged me I couldn't format things better.

@DanTup

DanTup commented Nov 4, 2020

Copy link
Copy Markdown
Member

Tests failures look like unrelated flakes; will investigate on master if red after landing this.

Thanks!

@DanTup
DanTup merged commit 2cf8f52 into Dart-Code:master Nov 4, 2020
@DanTup DanTup added in docs / website Relates to documentation, including the Dart Code website is enhancement An enhancement or improvement that should be listed in release notes but is not a bug fix. labels Nov 4, 2020
@DanTup DanTup added this to the v3.17.0 milestone Nov 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

in docs / website Relates to documentation, including the Dart Code website is enhancement An enhancement or improvement that should be listed in release notes but is not a bug fix.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants