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

[Docs] Sequence.Social does not exist in code, only README #3085

Open
velosol opened this issue Mar 28, 2023 · 0 comments
Open

[Docs] Sequence.Social does not exist in code, only README #3085

velosol opened this issue Mar 28, 2023 · 0 comments

Comments

@velosol
Copy link

velosol commented Mar 28, 2023

Describe the bug
The README.md mentions Sequence.Social in the support tables (as Seq. - Social) but there does not appear to be any matching code in https://github.com/microsoft/Recognizers-Text/tree/master/.NET/Microsoft.Recognizers.Text.Sequence/Extractors or e.g. https://github.com/microsoft/Recognizers-Text/tree/master/.NET/Microsoft.Recognizers.Text.Sequence/English/Extractors .

Assuming that 'Social' means 'Social Media' and not 'Social Security Number' (which I would expect under Number) then the 'Mention' Extractors make sense as 'Social Media Mentions' of the form @username implemented by Sequence.Mention.

To Reproduce
N/A beyond inspecting README and repo.

Expected behavior
I expect README, as the initial documentation one sees, to match what is available in code and with minimal ambiguity. I suggest README tables replace 'Seq. - Social' with 'Seq. - Mentions' or 'Seq. - Social Media*' and a footnote that the social media sequence is implemented under Sequence.Mention .

Sample input/output
N/A
Platform (please complete the following information):
N/A

Additional context
N/A

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

No branches or pull requests

1 participant