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

Rename OptimalStringAlignement to OptimalStringAlignment #57

Merged
merged 1 commit into from
Dec 2, 2021

Conversation

ararslan
Copy link
Contributor

@ararslan ararslan commented Dec 2, 2021

The former is a misspelling of the latter: note the extra 'e' in "alignement." In renaming this, I've used deprecate_binding which correctly handles deprecations for types as well as exporting.

I've also corrected two issues with the docstring for this type:

  • The whole docstring was indented by 4 spaces, which Markdown interprets as a code block, so the whole docstring was code-quoted.
  • The docstring erroneously said that OSA is the unrestricted D-L distance, but it's actually the restricted D-L distance.

The former is a misspelling of the latter: note the extra 'e' in
"alignement." In renaming this, I've used `deprecate_binding` which
correctly handles deprecations for types as well as exporting.

I've also corrected two issues with the docstring for this type:
- The whole docstring was indented by 4 spaces, which Markdown
  interprets as a code block, so the whole docstring was code-quoted.
- The docstring erroneously said that OSA is the unrestricted D-L
  distance, but it's actually the restricted D-L distance.
@matthieugomez matthieugomez merged commit c149761 into matthieugomez:main Dec 2, 2021
@matthieugomez
Copy link
Owner

Great PR, thanks!

@ararslan ararslan deleted the aa/alignment branch December 2, 2021 19:13
@ararslan
Copy link
Contributor Author

ararslan commented Dec 2, 2021

Thank you!

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

Successfully merging this pull request may close these issues.

2 participants