Skip to content

docs: fix typos in developer docs and VM scripts - #16674

Closed
vaibhav8a wants to merge 2 commits into
JabRef:mainfrom
vaibhav8a:fix-doc-typos
Closed

docs: fix typos in developer docs and VM scripts#16674
vaibhav8a wants to merge 2 commits into
JabRef:mainfrom
vaibhav8a:fix-doc-typos

Conversation

@vaibhav8a

Copy link
Copy Markdown

Six typo fixes across developer docs and scripts:

File Fix
docs/code-howtos/faq.md:90 commitingcommitting
docs/code-howtos/openoffice/ooresult-ooerror/ooresult-alternatives.md:92,369 exeptionexception
jablib/src/test/resources/testbib/issue-12274/README.md:5 Straight-fowardforward
scripts/vms/windows10/README.md:14 destorydestroy
scripts/vms/windows11/README.md:14 destorydestroy

Documentation prose only — no code, test data, or Vagrant commands changed.

@github-actions

Copy link
Copy Markdown
Contributor

Hey @vaibhav8a! 👋

Thank you for contributing to JabRef!

We have automated checks in place, based on which you will soon get feedback if any of them are failing. We also use Qodo for review assistance. It will update your pull request description with a review help and offer suggestions to improve the pull request.

After all automated checks pass, a maintainer will also review your contribution. Once that happens, you can go through their comments in the "Files changed" tab and act on them, or reply to the conversation if you have further inputs. You can read about the whole pull request process in our contribution guide.

Please ensure that your pull request is in line with our AI Usage Policy and make necessary disclosures.

@qodo-free-for-open-source-projects

Copy link
Copy Markdown
Contributor

PR Summary by Qodo

Correct typos in developer and VM documentation

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Corrects spelling errors across developer guides and issue reproduction instructions.
• Fixes the documented Vagrant destroy command for Windows 10 and 11 VMs.
High-Level Assessment

Directly correcting the affected Markdown text is the optimal approach; broader automation or structural changes would be disproportionate for six isolated typos.

Files changed (5) +6 / -6

Documentation (5) +6 / -6
faq.mdCorrect fetcher contribution wording +1/-1

Correct fetcher contribution wording

• Corrects “commiting” to “committing” in the link text for fetcher test guidance.

docs/code-howtos/faq.md

ooresult-alternatives.mdCorrect exception terminology +2/-2

Correct exception terminology

• Corrects two misspellings of “exception” in the OpenOffice result and error-handling design notes.

docs/code-howtos/openoffice/ooresult-ooerror/ooresult-alternatives.md

README.mdCorrect issue example heading +1/-1

Correct issue example heading

• Corrects “Straight-foward-case” to “Straight-forward-case” in the issue 12274 reproduction guide.

jablib/src/test/resources/testbib/issue-12274/README.md

README.mdCorrect Windows 10 Vagrant command +1/-1

Correct Windows 10 Vagrant command

• Corrects the documented recovery command from 'vagrant destory' to 'vagrant destroy'.

scripts/vms/windows10/README.md

README.mdCorrect Windows 11 Vagrant command +1/-1

Correct Windows 11 Vagrant command

• Corrects the documented recovery command from 'vagrant destory' to 'vagrant destroy'.

scripts/vms/windows11/README.md

@qodo-free-for-open-source-projects

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can hide the parts of a finding you never read, like the evidence or the agent prompt

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@github-actions github-actions Bot added the status: changes-required Pull requests that are not yet complete label Aug 25, 2026
@koppor

koppor commented Aug 25, 2026

Copy link
Copy Markdown
Member

@vaibhav8a Since you removed the checklist, the license of your changes is unclear. Can you re-add the checklist or is this a one shot PR?

@faneeshh

Copy link
Copy Markdown
Collaborator

I think it's fine. Just typo changes.

@jabref-machine

Copy link
Copy Markdown
Collaborator

You have removed the section "Checklist" from your pull request description. Please adhere to our pull request template.

@Siedlerchr Siedlerchr closed this Aug 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

first contrib status: changes-required Pull requests that are not yet complete

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants