You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
While reviewing spelling errors identified by the spellchecker, @zslade and I have noticed that we're very inconsistent when it comes to capitalising names, when used in functions class names.
Comparison'Exact match vs. Names with phonetic exact match vs. First_Name within levenshtein threshold 1 vs. First_Name within damerau-levenshtein threshold 1 vs. First_Name within jaro_winkler thresholds 0.9, 0.8 vs. anything else'of"first_name"and"first_name_dm".
SimilarityisassessedusingthefollowingComparisonLevels:
-'Null'withSQLrule: "first_name_l"ISNULLOR"first_name_r"ISNULL-'Exact match first_name'withSQLrule: "first_name_l"="first_name_r"-'Exact match first_name_dm'withSQLrule: "first_name_dm_l"="first_name_dm_r"-'Damerau_levenshtein <= 1'withSQLrule: damerau_levenshtein("first_name_l", "first_name_r") <=1-'Jaro_winkler_similarity >= 0.9'withSQLrule: jaro_winkler_similarity("first_name_l", "first_name_r") >=0.9-'Jaro_winkler_similarity >= 0.8'withSQLrule: jaro_winkler_similarity("first_name_l", "first_name_r") >=0.8-'All other comparisons'withSQLrule: ELSE<ComparisonExactmatchvs. Awithinlevenshteinthresholds1, 2vs. anythingelsewith4levelsat0x106d88c20>
Describe the solution you'd like
To achieve consistency and adhere to standard conventions in our documentation and the wider literature, we propose capitalizing the names in such instances.
Additionally, we've noticed occasional partial capitalisation, notably with cases such as "jaro-winkler", due to the use of the capitalize() method. This only modifies the first letter of the string, leading to outputs like Jaro-winkler from "jaro-winkler".capitalize().
The text was updated successfully, but these errors were encountered:
ThomasHepworth
changed the title
[MAINT] Ensuring Consistent Capitalization in Names of Functions and Classes Named After People
[MAINT] Ensuring Consistent Capitalisation in Names of Functions and Classes Named After People
Mar 27, 2024
ThomasHepworth
changed the title
[MAINT] Ensuring Consistent Capitalisation in Names of Functions and Classes Named After People
[MAINT] Ensuring consistent capitalisation when referencing functions named after people
Mar 27, 2024
ThomasHepworth
changed the title
[MAINT] Ensuring consistent capitalisation when referencing functions named after people
[MAINT] Ensure consistent capitalisation when referencing functions named after people
Apr 16, 2024
Is your proposal related to a problem?
While reviewing spelling errors identified by the spellchecker, @zslade and I have noticed that we're very inconsistent when it comes to capitalising names, when used in functions class names.
For example, both
ctl.name_comparison
andcl.levenshtein_at_thresholds
present these functions in lowercase:producing the following outputs:
Describe the solution you'd like
To achieve consistency and adhere to standard conventions in our documentation and the wider literature, we propose capitalizing the names in such instances.
Additionally, we've noticed occasional partial capitalisation, notably with cases such as "jaro-winkler", due to the use of the
capitalize()
method. This only modifies the first letter of the string, leading to outputs likeJaro-winkler
from"jaro-winkler".capitalize()
.The text was updated successfully, but these errors were encountered: