Skip to content

fix(docs): correct typos and improve consistency across articles #145

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 7 commits into from
Jun 28, 2025

Conversation

QuestSWE
Copy link
Contributor

This pull request fixes multiple typographical, grammatical, and minor wording issues across various documentation files.

  • Corrects typos and missing words or duplicates
  • Improves clarity and consistency in phrasing
  • No changes were made to technical content or formatting logic

Additionally:

  • Removed one <param> XML comment that referred to a non-existent parameter
  • Removed one line of unreachable code that had been left behind after a previous refactor (X = Y; immediately overridden on the next line)

These were small, safe cleanups to prevent confusion or dead code.

These edits follow the style and tone already established in the project.

Let me know if you’d like anything adjusted.

Copy link
Contributor

@AristurtleDev AristurtleDev left a comment

Choose a reason for hiding this comment

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

Overall good work @QuestSWE and thanks for the fixes.

There are some minor changes requested

  1. Avoid using contractions (such as "we're", use "we are" instead).
  2. One section and ordered list was changed to an unordered list. It should be ordered since the statements presented are done so in order of execution.
  3. A few places where < > got added around the xref links when it's not needed.

@QuestSWE
Copy link
Contributor Author

All the changes above have been resolved.

Copy link
Contributor

@AristurtleDev AristurtleDev left a comment

Choose a reason for hiding this comment

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

@SimonDarksideJ Should be good on this one

@SimonDarksideJ SimonDarksideJ merged commit 18a0d75 into MonoGame:main Jun 28, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants