Skip to content

Docs: Fix typos, outdated/incorrect info, etc. in guide codes - #290

Merged
garyo merged 2 commits into
AcademySoftwareFoundation:mainfrom
umajho:fix-guide-code-comments
Nov 11, 2026
Merged

garyo merged 2 commits into
AcademySoftwareFoundation:mainfrom
umajho:fix-guide-code-comments

Conversation

@umajho

@umajho umajho commented Nov 10, 2026

Copy link
Copy Markdown
Contributor
  • Comments:
    • Inconsistency:
      • Example 1: The article the is present in the comments for every other action except UnloadAction. I added the missing the.
      • Example 1: One sentence reads “the second action called to describe what the plugin does” in this example, while in all other examples the same sentence reads “… in a specific context”. I changed the former to the later.
      • Example 4: “finally find the position of the first component of column” -> “… of the column”.
    • Outdated:
      • “… the two functions that a host application will look for after loading the binary …” -> “… the two required function …”. Since the introduction of the optional OfxSetHost, there are now three functions of this kind.
    • Incorrect:
      • Example 4: “name of our two params” -> “name of our param”
      • Example 4: “set the component types we can handle on our main input” referring to the mask clip.
      • Example 4&5: The comments for the function Blend are just copied from those for Clamp.
      • Example 4: The “and” in “and do some processing” is no longer appropriate because the comment that the “and” bridges is no longer present in this example.
      • Example 4&5: The comments describing the construction of “sourceImg”'s are just copied from those for outputImg.
      • Example 5: The comment for the invocation of “Blend” is unchanged from Example 4.
      • Example 5: Render scale is added in this example, but a comment has not been updated to reflect this.
      • Example 5: “… and we are at the identity” appears in a function that is not for the Identity action. It seems to have been copied from another comment in the function for the Identity action without being updated.
    • Typo:
      • “on out output” -> “on our output”
      • “to a our” -> “to our”
    • Misc.:
      • “(three boot strapper functions will be however)” sounds unfinished to me, so I expanded it into a complete sentence. (Though, my intuition might be wrong. I'm not a native speaker.)
  • String literals:
    • typo: “callewd” -> “called” and “kOfxAcrtionLoad” -> “kOfxActionLoad”

Signed-off-by: umajho <umajho@proton.me>
@garyo

garyo commented Nov 11, 2026

Copy link
Copy Markdown
Contributor

This is clearly fine, thank you! The CI failure is temporary name resolution, not related.

@garyo
garyo merged commit 4249fe1 into AcademySoftwareFoundation:main Nov 11, 2026
44 of 49 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.

2 participants