add threshold None and label docstrings for String #189
Conversation
This file contains 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
EdAbati
added a commit
to EdAbati/recordlinkage
that referenced
this pull request
Feb 10, 2024
* Fix usage examples (J535D165#190) * Fix broken links (J535D165#186) This commit fixes broken links in readme. * Add threshold None and label docstrings for String (J535D165#189) * Add support for pandas==2 (J535D165#192) * Replace setup.py by pyproject.toml (J535D165#195) * Lint with Ruff and format with Black (J535D165#196) * Lint with Ruff and format with Black * Fix more lint issues * Fix datasets submodule * Fix all lint errors * Fix importerror * Replace flake8 in github action by ruff * Fix linter * Fix abstractmethod errors * Fix test with incorrect error * Update ci-workflow.yml * Update CI docs generation and CI pipeline (J535D165#197) * Bump minimal versions of dependencies * Update the docs CI pipeline (J535D165#198) * Add requirements to .readthedocs.yaml * Bump minimal Python version in documentation * Add pre-commit hooks (J535D165#199) * Update CI pipeline for publishing package * disable docs and publish GH actions * only trigger on PR * fixed linting * updated to latest ruff * Update GitHub Actions workflows --------- Co-authored-by: Martinho Hoffman <39743428+martinhohoff@users.noreply.github.com> Co-authored-by: andyjessen <62343929+andyjessen@users.noreply.github.com> Co-authored-by: David GG <37239554+davidggphy@users.noreply.github.com> Co-authored-by: Jonathan de Bruin <jonathandebruinos@gmail.com>
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.
When using String comparins, it is not evident in the docstring that you don't need to set a threshold.
The default value is None, and in case of using it you receibe the float number math metric instead of a 0/1 value.
This is stated in the docstring.
Also,
labelinput was not explained in the docstring. So it has been added.