Skip to content

Doc, Error Message, and Comment String Spelling Corrections#11279

Merged
mitchute merged 10 commits intodevelopfrom
cleanup-spellings
Oct 24, 2025
Merged

Doc, Error Message, and Comment String Spelling Corrections#11279
mitchute merged 10 commits intodevelopfrom
cleanup-spellings

Conversation

@mitchute
Copy link
Collaborator

Pull request overview

Not the most urgent issue, but this cleans up some spelling errors in the docs, error strings, and comments. Our practice of copy/pasting large blocks of text around to create new files and tests just helps these minor errors to continue to proliferate. I'm not sure my scripts are worth uploading here, but I may drop them on my personal gist for reference later.

Description of the purpose of this PR

Pull Request Author

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
  • Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
  • Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
  • If any diffs are expected, author must demonstrate they are justified using plots and descriptions
  • If changes fix a defect, the fix should be demonstrated in plots and descriptions
  • If any defect files are updated to a more recent version, upload new versions here or on DevSupport
  • If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
  • If structural output changes, add to output rules file and add OutputChange label
  • If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies

Reviewer

  • Perform a Code Review on GitHub
  • If branch is behind develop, merge develop and build locally to check for side effects of the merge
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified
  • Check that performance is not impacted (CI Linux results include performance check)
  • Run Unit Test(s) locally
  • Check any new function arguments for performance impacts
  • Verify IDF naming conventions and styles, memos and notes and defaults
  • If new idf included, locally check the err file and other outputs

@mitchute mitchute added the Defect Includes code to repair a defect in EnergyPlus label Oct 16, 2025
@mitchute mitchute self-assigned this Oct 16, 2025
@mitchute mitchute requested a review from mjwitte October 16, 2025 22:04
@shorowit
Copy link
Contributor

Nice. And this is after I already fixed hundreds of typos in a previous PR!

@mitchute
Copy link
Collaborator Author

Nice. And this is after I already fixed hundreds of typos in a previous PR!

In that case, maybe I'll polish up my scripts a bit add them to a pre-release checklist so this doesn't get too out of hand again.

@github-actions
Copy link

⚠️ Regressions detected on ubuntu-24.04 for commit 77e7d0d

Regression Summary
  • Table Big Diffs: 678
  • Table String Diffs: 678
  • ERR: 5

@github-actions
Copy link

⚠️ Regressions detected on macos-14 for commit 77e7d0d

Regression Summary
  • Table Big Diffs: 676
  • Table String Diffs: 676
  • ERR: 5

@JasonGlazer
Copy link
Contributor

@mitchute way to go, this type of clean up is always good!

@rraustad
Copy link
Collaborator

Engwish is wary hard. Nice job.

@mitchute mitchute added this to the EnergyPlus 25.2 milestone Oct 22, 2025
@mitchute mitchute merged commit 3cded00 into develop Oct 24, 2025
10 of 12 checks passed
@mitchute mitchute deleted the cleanup-spellings branch October 24, 2025 03:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Defect Includes code to repair a defect in EnergyPlus

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants