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

Fix typo in example of BackTranslation class docstring #671

Merged
merged 1 commit into from Jun 18, 2022

Conversation

JohnGiorgi
Copy link
Contributor

@JohnGiorgi JohnGiorgi commented Jun 18, 2022

What does this PR do?

Summary

The example in the docstring of the BackTranslation example appears to have a typo: the transformation is given as BackTranslation (a reference to the class) but should be BackTranslation() (an instance of the class).

Additions

  • N/A

Changes

  • Correct example in docstring of BackTranslation class to correctly instantiate BackTranslation() as the transformation

Deletions

  • N/A

Checklist

  • The title of your pull request should be a summary of its contribution.
  • Please write detailed description of what parts have been newly added and what parts have been modified. Please also explain why certain changes were made.
  • If your pull request addresses an issue, please mention the issue number in the pull request description to make sure they are linked (and people consulting the issue know you are working on it)
  • To indicate a work in progress please mark it as a draft on Github.
  • Make sure existing tests pass.
  • Add relevant tests. No quality testing = no merge.
  • All public methods must have informative docstrings that work nicely with sphinx. For new modules/files, please add/modify the appropriate .rst file in TextAttack/docs/apidoc.'

The example in the docstring of the BackTranslation example appears to have a typo: the `transformation` is given as `BackTranslation` but should be `BackTranslation()` (an instance of the class).
Copy link
Collaborator

@jxmorris12 jxmorris12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@jxmorris12 jxmorris12 merged commit 54c3141 into QData:master Jun 18, 2022
@JohnGiorgi JohnGiorgi deleted the patch-1 branch June 25, 2022 22:52
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.

None yet

3 participants