Skip to content

[flutter_markdown] Fix typo in readme #5096

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

Merged
merged 8 commits into from
Oct 10, 2023
Merged

[flutter_markdown] Fix typo in readme #5096

merged 8 commits into from
Oct 10, 2023

Conversation

nohli
Copy link
Contributor

@nohli nohli commented Oct 9, 2023

Since HTML is pronounced with an A at the beginning (at least by around 85% of people), it should probably be spelled an HTML.

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.
  • I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@@ -17,10 +17,10 @@ containing a rich text representation.
the Markdown into an abstract syntax tree (AST). The nodes of the AST are an
HTML representation of the Markdown data.

## Flutter Isn't a HTML Renderer
## Flutter Isn't an HTML Renderer
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd argue the H in HTML is sounded, and thus a is correct in this position per https://owl.purdue.edu/owl/general_writing/grammar/articles_a_versus_an.html

Hey @sfshaza2 or @atsansone wanna tie break?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In the link, there is no instance of "a h", but twice "an h"

Exceptions
Use "an" before a silent or unsounded "h." Because the "h" does not have any phonetic representation or audible sound, the sound that follows the article is a vowel; consequently, "an" is used.
an honorable peace
an honest error

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd argue the H in HTML is sounded

For an initialism it doesn't really make sense to say a letter is sounded or unsounded; the sound of the letters isn't used at all.

The deciding factor is the pronunciation of the letter H as a word. Since Flutter style uses US English spelling, we should spell this based on prevailing US pronunciation (which starts with an "ay"/"ai" sound), making "an" correct.

@domesticmouse domesticmouse requested a review from sfshaza2 October 9, 2023 22:47
@nohli nohli requested a review from stuartmorgan-g October 10, 2023 14:55
@domesticmouse domesticmouse removed the request for review from sfshaza2 October 10, 2023 22:03
fluttermirroringbot pushed a commit to flutter/flutter that referenced this pull request Oct 12, 2023
flutter/packages@4b483f2...93c3f69

2023-10-12 [email protected] [shared_preferences] update file version constraints (flutter/packages#5121)
2023-10-12 [email protected] [cross_file] Improved documentation about ignored parameters in IO module. (flutter/packages#4416)
2023-10-11 [email protected] [in_app_purchase] [#135759] Fix. doc reference finishPurchase to completePurchase. (flutter/packages#5081)
2023-10-10 [email protected] Update repo README issues link (flutter/packages#5106)
2023-10-10 [email protected] [flutter_markdown] Fix typo in readme (flutter/packages#5096)
2023-10-10 [email protected] [camerax] Implements torch mode (flutter/packages#4903)
2023-10-10 [email protected] [shared_preferences] fix documentation wording (flutter/packages#4986)
2023-10-10 [email protected] [two_dimensional_scrollables] Fix paint bug when rows/columns are pinned and axes are reversed (flutter/packages#5038)
2023-10-10 [email protected] Roll Flutter from f52fe4f to 83134ac (25 revisions) (flutter/packages#5104)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autosubmit Merge PR when tree becomes green via auto submit App p: flutter_markdown
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants