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

[FEAT] Update ctl docs so it's clearer how phonetic columns work #1583

Closed
afua-moj opened this issue Sep 7, 2023 · 0 comments · Fixed by #1624
Closed

[FEAT] Update ctl docs so it's clearer how phonetic columns work #1583

afua-moj opened this issue Sep 7, 2023 · 0 comments · Fixed by #1624
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@afua-moj
Copy link
Contributor

afua-moj commented Sep 7, 2023

Is your proposal related to a problem?

I was just writing up an issue, to request that we can have a phonetic_fullname_col_name in the ctl.forenameSurnameComparison and realised when looking at the code that this is done automatically if you include phonetic_forename_col_name and phonetic_surname_col_name.

In the docs it says "Including this parameter will create an exact match level for phonetic_surname_col_name" which doesn't capture everything the code says.

Describe the solution you'd like

Small update to the doc to make this functionality clear. If

phonetic_forename_col_name (str, optional): The name of the column with
                phonetic reduction (such as dmetaphone) of forename_col_name. Including
                parameter along with `phonetic_surname_col_name` will create an exact match level for
                "Full name phonetic match".
                Defaults to None








@afua-moj afua-moj added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 7, 2023
@afua-moj afua-moj changed the title [FEAT] Update docs so it's clearer how phonetic columns work [FEAT] Update ctl docs so it's clearer how phonetic columns work Sep 7, 2023
@afua-moj afua-moj self-assigned this Sep 25, 2023
@afua-moj afua-moj mentioned this issue Sep 26, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant