Repository navigation
MMCore: fix typos and missing periods in doc comments - #1013
Merged
Merged
Conversation
Fix typos ("positionf", "shoudl", "ofimages", "opimal", "BGRA888", ...)
and add the periods missing at the ends of sentences that are followed
by another sentence on the next line. Without them, anything that
rewraps the text (Doxygen, IDE hovers, generated Python docstrings)
runs the two sentences together.
Comment-only change.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
Typos and missing periods in MMCore.cpp doc comments.
a lot of these comments have a sentence per line with no period, so anything that rewraps the text (Doxygen, IDE hovers, the generated docstrings in pymmcore-nano) runs them together, e.g. "...exposures in a camera This should only be called...".