Skip to content

FEATURE: Add ability to ignore chunks of comments #69

Closed
Closed
FEATURE: Add ability to ignore chunks of comments#69

Description

@hjmjohnson
hjmjohnson
opened on Sep 24, 2025

In ITK there are many spelling words added to the dictionary to deal with ASCII art:

Like adding the words

oooooooooooo
oXooooooooooooooooooo

to deal with ASCII art

https://github.com/InsightSoftwareConsortium/ITK/blob/7ca2f0e73e84fd0563b80061d31b1c7f97bea23c/Modules/Numerics/Statistics/test/itkSpatialNeighborSubsamplerTest.cxx#L38

InsightSoftwareConsortium/ITK#5475 (comment)

PROPOSAL 1:

Add a file separate from the main dictionary to describe per-file-pattern spelling exceptions.

# per_file_dictionary_excptions.txt
# allowed words.             : regex for file pattern matching... ".*' is the default if not specified
oooooooooooo               : '.*SpatialNeighborSubsampler.*'
oXooooooooooooooooooo :  '.*SpatialNeighborSubsampler.*'

PROPOSAL 2:

Have in code spelling checking disable/enable as comments

// spell-check : OFF
// spell-check : ON

Activity

  1. hjmjohnson commented on Sep 24, 2025

    @hjmjohnson
    hjmjohnson
    on Sep 24, 2025
    Author

    @dave3d This is a proposal that would allow for a main dictionary that is compatible with many tools (i.e. ispell, ide's) and an auxiliary dictionary that provides per-file exceptions for the pull-requests.

    I don't think there is a great solution to all the issues related to automated spell checking.

  2. dave3d commented on Sep 24, 2025

    @dave3d
    dave3d
    on Sep 24, 2025
    Member

    I like the 2nd proposal. I've thought about doing something like that but didn't really have the time/motivation.

  3. hjmjohnson commented on Oct 2, 2025

    @hjmjohnson
    hjmjohnson
    on Oct 2, 2025
    Author

    Resolved in #70

  4. hjmjohnson
    closed this as completedon Oct 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions