Skip to content

Update docs for using generate_package_description.py #172

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jan 31, 2023
Merged

Update docs for using generate_package_description.py #172

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7b1940f
Update docs for using generate_package_description.py
jeongsoolee09 Jan 25, 2023
6dc882a
Merge branch 'main' into jeongsoolee09/fix-doc-for-generating-script
jeongsoolee09 Jan 27, 2023
4a4beda
Merge branch 'main' into jeongsoolee09/fix-doc-for-generating-script
jeongsoolee09 Jan 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/development_handbook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,10 +175,10 @@ pip install -r scripts/requirements.txt
To generate the rule package description file, run the following script from the root of the repository:

```
python3.9 scripts/generate_rules/generate_package_description.py <rule_package_name>
python3.9 scripts/generate_rules/generate_package_description.py <target_lang_name> <rule_package_name>
```

This will produce a `.json` file in the `rule_packages` directory with the name of the rule package (e.g. `rule_packages/Literals.json`).
This will produce a `.json` file in the `rule_packages` directory with the name of the rule package (e.g. `rule_packages/Literals.json`). For example, `python3.9 scripts/generate_rules/generate_package_description.py c Types` creates `rule_packages/c/Types.json`.

#### Step 2: Review and update the rule package description file

Expand Down