Skip to content

Fix spelling and grammar in PC2.Models.Agency XML comments and summaries #481

@JoeProgrammer88

Description

@JoeProgrammer88

The PC2.Models.Agency file (PC2/Models/Agency.cs) contains several spelling and grammar mistakes in XML comments and method summaries. These are documentation issues that should be fixed to improve code quality and readability.

Suggested fixes (with approximate line locations):

  • Line 7: "Represents a agency as a object" -> "Represents an agency as an object".
  • Line 44: "The city the agency's is located" -> "The city where the agency is located" (or "The city where the agency is located in").
  • Line 49: "The state the agency is located" -> "The state where the agency is located".
  • Line 110 and 126: "formated" -> "formatted" (both method summaries and return descriptions).
  • Line 158: "The agency's contact information" is used for AgencyName2 — consider clarifying (e.g. "The agency's alternative name" or "Second agency name") if that was intended.
  • Line 79/80: "The agency's telecommunications device for the deaf's number" -> "The agency's Telecommunications Device for the Deaf (TDD) number".
  • Any other occurrences of "agency's is" (extra apostrophe) — remove or rephrase as needed.

Optional improvements:

  • Standardize phrasing (use "where the agency is located" consistently).
  • Use nullable-aware XML comments where appropriate.

Please assign this to someone to update the XML comments in PC2/Models/Agency.cs. If useful I can prepare a small PR that applies the text edits.

Files to edit:

  • PC2/Models/Agency.cs

Labels: documentation, bug (doc).

Metadata

Metadata

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions