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 typos in documentation and code #538

Merged
merged 1 commit into from
Feb 21, 2024
Merged

Conversation

stweil
Copy link
Contributor

@stweil stweil commented Feb 20, 2024

All of them were found using typos.

All of them were found using `typos`.

Signed-off-by: Stefan Weil <[email protected]>
@stweil
Copy link
Contributor Author

stweil commented Feb 20, 2024

More typos can be found in release-notes/*.dita. Should those be fixed, too? If yes, I can send either a separate pull request or add a 2nd commit to the one here.

@jelovirt jelovirt requested a review from infotexture February 21, 2024 09:18
@jelovirt jelovirt added the typo Typographical errors & minor misprints label Feb 21, 2024
Copy link
Member

@infotexture infotexture left a comment

Choose a reason for hiding this comment

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

🙏 Thanks Stefan, this is helpful.

I wasn't aware of typos, but it looks like a lightweight addition to the linting quiver. (Particularly useful that it's smart enough to parse IDs and catch typos there too.)

A while back in #284, we considered Vale, but never plugged it in and haven't gotten around to revisiting that after significant changes in recent Vale versions.

To use this in CI, we'd need to fix the false positives thrown for DITA-OT, but that looks to be straightforward and can be done in a separate PR.

The old Release Notes files are archived for posterity, but no longer actively maintained, so good call not to touch those here.

P.S. Interesting to see the DITA-OT docs CSS re-used in the Ground Truth Guidelines. 👀

@infotexture infotexture merged commit 8379a36 into dita-ot:develop Feb 21, 2024
4 checks passed
@stweil stweil deleted the typos branch February 22, 2024 06:48
infotexture added a commit that referenced this pull request Feb 28, 2024
* develop:
  Cache Node.js and Java dependencies in GitHub Actions
  Update Node.js version in GitHub Actions to 20.x
  Add NVM configuration for setting local Node.js version
  Update GitHub Actions' action versions
  Fall back to archive.org for HTML Help Workshop †
  Fix typos in documentation and code (#538)
  Revise font-selection-strategy caveat for FOP 2.9
  Update docs GitHub Actions for 4.2 (#535)
infotexture added a commit that referenced this pull request Feb 29, 2024
* hotfix/4.2.1:
  Favor JDKs & add package managers as Java sources
  Update <shortdesc> w/ maintenance release pattern
  Add details on issues resolved in 4.2.1
  Remove redundant Contributors section
  Add standard intro to maintenance release section
  Mark latest hotfix updates
  Bump Docker image version to ”4.2.1“
  Bump 'maintenance-version' key to “4.2.1”
  Draft 4.2.1 Release Notes (#541)
  Cache Node.js and Java dependencies in GitHub Actions
  Update Node.js version in GitHub Actions to 20.x
  Add NVM configuration for setting local Node.js version
  Update GitHub Actions' action versions
  Fall back to archive.org for HTML Help Workshop †
  Fix typos in documentation and code (#538)
  Revise font-selection-strategy caveat for FOP 2.9
  Update docs GitHub Actions for 4.2 (#535)
infotexture added a commit that referenced this pull request Mar 1, 2024
* hotfix/4.2.1:
  Remove WIP from 4.2.1 section title
  Favor JDKs & add package managers as Java sources
  Update <shortdesc> w/ maintenance release pattern
  Add details on issues resolved in 4.2.1
  Remove redundant Contributors section
  Add standard intro to maintenance release section
  Mark latest hotfix updates
  Bump Docker image version to ”4.2.1“
  Bump 'maintenance-version' key to “4.2.1”
  Draft 4.2.1 Release Notes (#541)
  Cache Node.js and Java dependencies in GitHub Actions
  Update Node.js version in GitHub Actions to 20.x
  Add NVM configuration for setting local Node.js version
  Update GitHub Actions' action versions
  Fall back to archive.org for HTML Help Workshop †
  Fix typos in documentation and code (#538)
  Revise font-selection-strategy caveat for FOP 2.9
  Update docs GitHub Actions for 4.2 (#535)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
typo Typographical errors & minor misprints
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants