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

Fix typo in MDX documentation #67432

Merged
merged 2 commits into from
Jul 4, 2024
Merged

Conversation

ManuLpz4
Copy link
Contributor

@ManuLpz4 ManuLpz4 commented Jul 3, 2024

I was reading the documentation related to MDX and noticed a typo in some articles, so I fixed them.

Although I read the Contribution Guidelines this is my first contribution so feel free to comment if I can do better.

@ijjk ijjk added Documentation Related to Next.js' official documentation. type: next labels Jul 3, 2024
@ijjk
Copy link
Member

ijjk commented Jul 3, 2024

Allow CI Workflow Run

  • approve CI run for commit: 5c633b9

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

@ManuLpz4 ManuLpz4 marked this pull request as draft July 3, 2024 21:22
@Netail
Copy link
Contributor

Netail commented Jul 3, 2024

I believe the article (a or an) in this case refers to the word file, so a file (the current way) should be correct

@ManuLpz4 ManuLpz4 marked this pull request as ready for review July 3, 2024 21:49
@ManuLpz4
Copy link
Contributor Author

ManuLpz4 commented Jul 3, 2024

I believe the a/an in this case refers to file, so a file should be correct

I believe the article (a or an) in this case refers to the word file, so a file (the current way) should be correct

Hey, @Netail! Thank you for helping me on my first PR. I'm looking for official recommendations on it and I only found that the preceding word is the part the defines if it should be an a or an an.

Do you have some article talking about the principle noun? I'm not a native speaker so maybe it is something that is not written but commonly used :)

Some links:

@devjiwonchoi
Copy link
Member

@Netail Thank you for helping out! As we are going to read as an MDX components dot tsx file, I also agree that it can be written with an.

x-ref: https://www.britannica.com/dictionary/eb/qa/how-do-you-know-whether-to-use-a-or-an

Copy link
Member

@devjiwonchoi devjiwonchoi left a comment

Choose a reason for hiding this comment

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

Thank you for the PR! Great catch :)

@devjiwonchoi devjiwonchoi enabled auto-merge (squash) July 4, 2024 10:48
@devjiwonchoi devjiwonchoi merged commit 49f9c46 into vercel:canary Jul 4, 2024
33 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation Related to Next.js' official documentation. locked type: next
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants