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.

Sign up for GitHub

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2fbfb10
Fix typo in readme
nohli Oct 9, 2023
fb47a6a
Update version
nohli Oct 9, 2023
d74676b
Update CHANGELOG.md
nohli Oct 9, 2023
08ea7db
Update version style
nohli Oct 10, 2023
1bfa8fa
Update version style
nohli Oct 10, 2023
ec3fc91
Update version
nohli Oct 10, 2023
0813fdb
Update version and changelog
nohli Oct 10, 2023
8ff65c4
Merge branch 'main' into typo
domesticmouse Oct 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/flutter_markdown/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 0.6.18+1

* Fixes a typo in README.

## 0.6.18

* Adds support for `footnote`.
Expand Down
4 changes: 2 additions & 2 deletions packages/flutter_markdown/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.


While this approach to creating a rich text representation of Markdown source
text in Flutter works well, Flutter isn't a HTML renderer like a web browser.
text in Flutter works well, Flutter isn't an HTML renderer like a web browser.
Markdown was developed by John Gruber in 2004 to allow users to turn readable,
plain text content into rich text HTML. This close association with HTML allows
for the injection of HTML into the Markdown source data. Markdown parsers
Expand Down
2 changes: 1 addition & 1 deletion packages/flutter_markdown/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: A Markdown renderer for Flutter. Create rich text output,
formatted with simple Markdown tags.
repository: https://github.com/flutter/packages/tree/main/packages/flutter_markdown
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+flutter_markdown%22
version: 0.6.18
version: 0.6.18+1

environment:
sdk: ">=3.0.0 <4.0.0"
Expand Down