Skip to content

DOC: Edit phrasing and grammar of FDA software development guidelines#5991

Open
JakeKitzmann wants to merge 2 commits intoInsightSoftwareConsortium:mainfrom
JakeKitzmann:fix-FDA-phrasing
Open

DOC: Edit phrasing and grammar of FDA software development guidelines#5991
JakeKitzmann wants to merge 2 commits intoInsightSoftwareConsortium:mainfrom
JakeKitzmann:fix-FDA-phrasing

Conversation

@JakeKitzmann
Copy link
Copy Markdown

@JakeKitzmann JakeKitzmann commented Mar 30, 2026 •
edited
Loading

PR Checklist

  • No API changes were made (or the changes have been approved)
  • No major design changes were made (or the changes have been approved)
  • Added test (or behavior not changed)
  • Updated API documentation (or API not changed)
  • Added license to new files (if any)
  • Added Python wrapping to new files (if any) as described in ITK Software Guide Section 9.5
  • Added ITK examples for all new major features (if any)

Refer to the ITK Software Guide for
further development details if necessary.

@github-actions github-actions bot added type:Documentation Documentation improvement or change area:Documentation Issues affecting the Documentation module labels Mar 30, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Mar 30, 2026

Greptile Summary

This PR makes a series of grammar and phrasing corrections to the FDA software development guidelines documentation. The changes improve subject-verb agreement ("Whoever develop" → "Developers of such applications have"), fix tense issues ("will be responsible" → "are responsible"), correct a clear grammatical error ("That will included" → "This includes"), and simplify awkward phrasing ("the use you make of ITK" → "your use of ITK").

Key changes:

  • Pluralizes "The developer" to "Developers" and updates surrounding text accordingly throughout the opening section
  • Fixes the broken construction "Whoever develop such applications has" → "Developers of such applications have"
  • Corrects "That will included things like" → "This includes" (removes mixed-tense error)
  • Improves "It is worth to point out" → "It is worth it to point out" (removes unidiomatic infinitive after "worth"); using "It is worth pointing out" (gerund form) would be slightly more standard
  • No functional or API changes; documentation only

Confidence Score: 5/5

  • Safe to merge — documentation-only grammar fixes with no functional impact.
  • All changes are purely editorial improvements to a documentation file. No code, logic, or API is touched. The one remaining suggestion (gerund vs. "worth it to") is purely stylistic and does not block merge.
  • No files require special attention.

Important Files Changed
Filename Overview
Documentation/docs/learn/fda_sw_development_guidelines.md Documentation-only grammar and phrasing improvements: pluralizes "developer" to "developers", fixes "Whoever develop" agreement, simplifies phrasing, fixes "That will included" → "This includes", and corrects "worth to" → "worth it to".

Flowchart

 
%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Develop Medical Application\nusing ITK/VTK] --> B{Is application subject\nto FDA approval?}
    B -- Yes --> C[Developer is responsible\nfor validation]
    B -- No --> D[Standard development\npractices apply]
    C --> E[Validate use of ITK/VTK\nfunctionalities]
    C --> F[Validate all other OTS\nsoftware used]
    F --> F1[OS, Compiler, OpenGL,\nLibraries, Processor]
    E --> G[Demonstrate ITK/VTK\nbehaves as expected\nin application context]
    G --> H[Submit to FDA per\napplicable guidelines]
Loading

Reviews (1): Last reviewed commit: "DOC: Edit phrasing and grammar of FDA so..." | Re-trigger Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@greptile-apps greptile-apps[bot] greptile-apps[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

area:Documentation Issues affecting the Documentation module type:Documentation Documentation improvement or change

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@JakeKitzmann