Fix some typos in the documentation #995
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR fixes various typos, grammatical mistakes, and punctuation issues in the documentation files.
- Corrects contractions, hyphenations, and comma placements
- Improves overall readability and consistency across multiple docs files
Reviewed Changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 30 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/whyscip.rst | Fixed contraction and hyphenation issues |
| docs/tutorials/vartypes.rst | Added missing commas in notes and improved clarity |
| docs/tutorials/separator.rst | Removed an ambiguous inline comment and fixed a typo in "handled" |
| docs/tutorials/readwrite.rst | Added hyphen in compound adjective "human-readable" |
| docs/tutorials/nodeselector.rst | Removed duplicate article "a" |
| docs/tutorials/model.rst | Fixed grammatical issues regarding variable descriptions and phrasing |
| docs/tutorials/logfile.rst | Replaced British English with American English and added needed punctuation |
| docs/tutorials/lazycons.rst | Fixed an unclosed string literal and corrected a typo in "constraint" |
| docs/tutorials/heuristic.rst | Fixed pluralization and standardized spelling of "behavior" |
| docs/tutorials/expressions.rst | Inserted a missing comma to improve sentence clarity |
| docs/tutorials/eventhandler.rst | Appended a comma after the inheritance clause |
| docs/tutorials/cutselector.rst | Fixed hyphenation and spelling errors |
| docs/tutorials/constypes.rst | Corrected a typo and improved comma usage |
| docs/tutorials/branchrule.rst | Improved comma usage and fixed compound word spacing |
| docs/similarsoftware.rst | Changed British to American spelling ("summarise" → "summarize") |
| docs/faq.rst | Replaced a comma with a period for better sentence structure |
| docs/extend.rst | Added punctuation for clarity and improved phrasing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.