Skip to content

fix a bunch of minor typos in docs and a bug in setting up FHD cal objects.#1676

Open
bhazelton wants to merge 3 commits into
mainfrom
fix_typos
Open

fix a bunch of minor typos in docs and a bug in setting up FHD cal objects.#1676
bhazelton wants to merge 3 commits into
mainfrom
fix_typos

Conversation

@bhazelton
Copy link
Copy Markdown
Member

@bhazelton bhazelton commented Jun 4, 2026

Description

Fix a bunch of minor typos in docs and docstrings. I found these because @steven-murray pointed out a typo in a previous PR. When I searched on that typo I found a bunch more. Then I installed a spell checker plugin and found even more 🤦‍♀️

I even found a typo that caused a bug in setting up FHD cal objects.

I almost certainly missed some, but this is a good start.

Motivation and Context

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation change (documentation changes only)
  • Version change
  • Build or continuous integration change
  • Other

Checklist:

Bug fix checklist:

  • My fix includes a new test that breaks as a result of the bug (if possible).
  • I have updated the CHANGELOG.

Documentation change checklist:

  • Any updated docstrings use the numpy docstring format.
  • If this is a significant change to the readme or other docs, I have checked that they are rendered properly on ReadTheDocs. You can check this via the RTD CI build.

@bhazelton bhazelton requested a review from jpober June 4, 2026 21:37
@bhazelton bhazelton added bug docs documentation labels Jun 4, 2026
self.gain_convention = "divide"
self.gain_scale = "Jy"
self.pol_convetions = "sum"
self.pol_convention = "sum"
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the only one that's not in docs or comments -- this is an actual bug.

@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.93%. Comparing base (a932d15) to head (8ea4069).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1676   +/-   ##
=======================================
  Coverage   99.93%   99.93%           
=======================================
  Files          67       67           
  Lines       22845    22845           
=======================================
  Hits        22831    22831           
  Misses         14       14           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

Labels

bug docs documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant