Skip to content

docs: fix typo in IP_ADDRESS detection method description#2133

Open
Coshea46 wants to merge 1 commit into
data-privacy-stack:mainfrom
Coshea46:patch-1
Open

docs: fix typo in IP_ADDRESS detection method description#2133
Coshea46 wants to merge 1 commit into
data-privacy-stack:mainfrom
Coshea46:patch-1

Conversation

@Coshea46

Copy link
Copy Markdown

Change Description

The documentation table incorrectly stated that the IP_ADDRESS entity detector validates a checksum. Checksums exist only at the packet level for IP addresses, which is not something a string-based entity recognizer can check. The IpRecognizer itself relies on regex pattern matching, context words, and structural validation via Python's ipaddress library; there's no checksum logic in it.

This PR removes the incorrect "and checksum" reference from docs/supported_entities.md and clarifies that detection relies on regex and context instead.

Describe your changes

  • Updated docs/supported_entities.md to remove the incorrect "checksum" claim for the IP_ADDRESS entity detector
  • Clarified that IpRecognizer relies on regex and context, not checksum validation

Issue reference

No tracked issue. Problem was found while reviewing the documentation.

Checklist

  • I have reviewed the contribution guidelines
  • I agree to follow this project's Code of Conduct
  • I confirm that I have the right to submit this contribution and that it does not knowingly contain proprietary or confidential code.
  • My code includes unit tests
  • All unit tests and lint checks pass locally
  • My PR contains documentation updates / additions if required

Table initially said IP_ADDRESS has to pass checksum, however IP addresses only use checksum at the packet level.
Also, the IPRecognizer uses regex pattern matching, context words, and structural validation via Python's ipaddress library, but no sign of checksum function.

Removed 'and checksum' from the documentation table.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant