Skip to content
This repository was archived by the owner on Nov 22, 2022. It is now read-only.

Fix Atis Tutorial Reference in Docstring #163

Conversation

m3rlin45
Copy link
Contributor

@m3rlin45 m3rlin45 commented Dec 27, 2018

Summary:
The reference to the atis tutorial in model.py doesn't work properly and is throwing a warning. This fixes it.
Test Plan:
make clean-all
make html
then validated the warning went away

existing docs look like:
https://pytext-pytext.readthedocs-hosted.com/en/latest/modules/pytext.models.html (grep for atis)
new ones look like (from CI build) https://834-143080897-gh.circle-artifacts.com/0/docs/modules/pytext.models.html
as you can see, the reference is nicely expanded

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have completed my CLA (see CONTRIBUTING)
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Summary:
The reference to the atis tutorial in model.py doesn't work properly and is throwing a warning. This fixes it.
Test Plan:
  make clean-all
  make html
then validated the warning went away
@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Dec 27, 2018
Copy link
Contributor

@facebook-github-bot facebook-github-bot left a comment

Choose a reason for hiding this comment

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

@m3rlin45 has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

Copy link
Contributor

@facebook-github-bot facebook-github-bot left a comment

Choose a reason for hiding this comment

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

@bethebunny is landing this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
CLA Signed Do not delete this pull request or issue due to inactivity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants