docs: fix typo in IP_ADDRESS detection method description#2133
Open
Coshea46 wants to merge 1 commit into
Open
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
IpRecognizeritself relies on regex pattern matching, context words, and structural validation via Python'sipaddresslibrary; there's no checksum logic in it.This PR removes the incorrect "and checksum" reference from
docs/supported_entities.mdand clarifies that detection relies on regex and context instead.Describe your changes
docs/supported_entities.mdto remove the incorrect "checksum" claim for theIP_ADDRESSentity detectorIpRecognizerrelies on regex and context, not checksum validationIssue reference
No tracked issue. Problem was found while reviewing the documentation.
Checklist