Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "colcon" to spell_check.words #1

Closed
wants to merge 1 commit into from

Conversation

furushchev
Copy link

To fix an error in CI

test/test_spell_check.py F..                                             [100%]
  
  =================================== FAILURES ===================================
  _______________________________ test_spell_check _______________________________
  
  known_words = ['apache', 'iterdir', 'pathlib', 'pytest', 'scspell', 'setuptools', ...]
  
      def test_spell_check(known_words):
          source_filenames = [Path(__file__).parents[1] / 'setup.py'] + \
              list(
                  (Path(__file__).parents[1] / 'colcon_awesome_pkg')
                  .glob('**/*.py')) + \
              list((Path(__file__).parents[1] / 'test').glob('**/*.py'))
      
          for source_filename in sorted(source_filenames):
              print('Spell checking:', source_filename)
      
          # check all files
          report = Report(known_words)
          spell_check(
              [str(p) for p in source_filenames], base_dicts=[SCSPELL_BUILTIN_DICT],
              report_only=report, additional_extensions=[('', 'Python')])
      
          unknown_word_count = len(report.unknown_words)
  >       assert unknown_word_count == 0, \
              'Found {unknown_word_count} unknown words: '.format_map(locals()) + \
              ', '.join(sorted(report.unknown_words))
  E       AssertionError: Found 1 unknown words: colcon
  E       assert 1 == 0
  
  test/test_spell_check.py:38: AssertionError
  ----------------------------- Captured stdout call -----------------------------

@cottsay
Copy link
Member

cottsay commented Aug 3, 2023

Without running the sed commands to actually replace the template values with actual package names, this package doesn't actually contain "colcon" anywhere that the spell checker is looking, so we can't take this PR as-is.

That said, it's pretty obnoxious that the tests immediately fail once you run those commands to set up your initial package. Maybe we can slip "colcon" in somewhere so that we can move forward with this change?

@furushchev
Copy link
Author

furushchev commented Sep 8, 2023

@cottsay Sorry for the delayed reply!
I see. How about making the CI test after running the exact commands written in README.rst?
Please refer to another PR: #3

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.

3 participants