Skip to content

Commit

Permalink
Update readme with writing goal info
Browse files Browse the repository at this point in the history
  • Loading branch information
p-goulart committed Jul 13, 2023
1 parent b14f06c commit 0bfa90f
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,11 @@ ABSAGE_SUBST
This script is meant to provide an all-encompassing view of **all** rules created by the lingu team in **one single file** – this means *all locales* are present in the same file. For example:

```csv
row,id,locale,source_repo,type,source_file,tone_tags,is_goal_specific
0,IN_SHANGHAI,en,os,grammar,grammar.xml,,false
1,IN_SHANGHAI,en,os,grammar,grammar.xml,,false
2,LOWERCASE_NAMES,fr,premium,grammar,grammar.xml,,false
3,SOME_EXAMPLE,es,os,style,grammar.xml,professional,true
row,id,subId,locale,source_repo,type,source_file,tone_tags,writing_goal,is_goal_specific
0,IN_SHANGHAI,1,en,os,grammar,grammar.xml,,,false
1,IN_SHANGHAI,2,en,os,grammar,grammar.xml,,,false
2,LOWERCASE_NAMES,1,fr,premium,grammar,grammar.xml,,,false
3,SOME_EXAMPLE,1,es,os,style,grammar.xml,professional,serious,true
```

#### Table headers
Expand All @@ -118,6 +118,7 @@ row,id,locale,source_repo,type,source_file,tone_tags,is_goal_specific
|type|'grammar', 'style', or 'unknown'|
|source_file|the path to the file where this rule comes from|
|tone_tags|comma-separated list of `tone_tags` applied to the the rule, including those inherited from rulegroups and categories|
|writing_goal|comma-separate list of writing goals served by the tone tags in the previous column|
|is_goal_specific|boolean value of `is_goal_specific` rule attribute|


Expand Down

0 comments on commit 0bfa90f

Please sign in to comment.