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

Documentation on the config files and config-related commands #984

Closed
wants to merge 1 commit into from

Conversation

Titousensei
Copy link
Contributor

Motivation and Context

PyText uses json config files, but there's no documentation on how to create and modify them.

How Has This Been Tested

Read the generated docs in circleCI

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.

@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Sep 17, 2019
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.

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

@facebook-github-bot
Copy link
Contributor

@Titousensei has updated the pull request. Re-import the pull request

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.

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

@facebook-github-bot
Copy link
Contributor

@Titousensei has updated the pull request. Re-import the pull request

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.

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

@Titousensei Titousensei deleted the cfg_doc branch September 24, 2019 00:04
facebook-github-bot pushed a commit that referenced this pull request Sep 24, 2019
Summary:
## Motivation and Context

PyText uses json config files, but there's no documentation on how to create and modify them.

## How Has This Been Tested

Read the generated docs in circleCI

## Types of changes

- [x] 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

- [x] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [x] I have updated the documentation accordingly.
- [x] I have read the **CONTRIBUTING** document.
- [x] I have completed my CLA (see **CONTRIBUTING**)
- [ ] I have added tests to cover my changes.
- [x] All new and existing tests passed.
Pull Request resolved: #984

Test Plan:
Look at the circleci artifacts for built documentation `config_commands.html` and `config_files.html`.

https://13610-143080897-gh.circle-artifacts.com/0/docs/config_commands.html

https://13610-143080897-gh.circle-artifacts.com/0/docs/config_files.html

Reviewed By: rutyrinott

Differential Revision: D17413280

Pulled By: Titousensei

fbshipit-source-id: b5cae927687942f3dd0f50907ae4f04ec236c4ab
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