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.

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

Jump to bottom

Update docs for cli.rst #465

Merged
merged 3 commits into from
Oct 22, 2024
Merged

Update docs for cli.rst #465

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dfce153
Updating the file with new added data types for diffrent commands
OmarAI2003 Oct 22, 2024
ae929b7
adding missing option 'ope,OUTPUTS_PER_ENTRY' to the get command
OmarAI2003 Oct 22, 2024
5cb2c54
updating Convert command options
OmarAI2003 Oct 22, 2024
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
17 changes: 12 additions & 5 deletions docs/source/scribe_data/cli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,10 @@ Example output:
adverbs
emoji-keywords
nouns
personal-pronouns
postpositions
prepositions
proper-nouns
verbs
-----------------------------------

Expand All @@ -94,7 +97,10 @@ Example output:
adverbs
emoji-keywords
nouns
personal-pronouns
postpositions
prepositions
proper-nouns
verbs
-----------------------------------

Expand All @@ -115,7 +121,10 @@ Example output:
adverbs
emoji-keywords
nouns
personal-pronouns
postpositions
prepositions
proper-nouns
verbs
-----------------------------------

Expand All @@ -137,6 +146,7 @@ Options:
- ``-dt, --data-type DATA_TYPE``: The data type(s) to get.
- ``-od, --output-dir OUTPUT_DIR``: The output directory path for results.
- ``-ot, --output-type {json,csv,tsv}``: The output file type.
- ``-ope, --outputs-per-entry OUTPUTS_PER_ENTRY``: How many outputs should be generated per data entry.
- ``-o, --overwrite``: Whether to overwrite existing files (default: False).
- ``-a, --all ALL``: Get all languages and data types.
- ``-i, --interactive``: Run in interactive mode.
Expand Down Expand Up @@ -257,7 +267,7 @@ Examples:

.. code-block:: text

$scribe-data total -lang English -dt nouns
$scribe-data total -lang English -dt nouns # verbs, adjectives, etc
Language: English
Data type: nouns
Total number of lexemes: 12345
Expand All @@ -278,7 +288,4 @@ Options:

- ``-f, --file FILE``: The file to convert to a new type.
- ``-ko, --keep-original``: Whether to keep the file to be converted (default: True).
- ``-json, --to-json TO_JSON``: Convert the file to JSON format.
- ``-csv, --to-csv TO_CSV``: Convert the file to CSV format.
- ``-tsv, --to-tsv TO_TSV``: Convert the file to TSV format.
- ``-sqlite, --to-sqlite TO_SQLITE``: Convert the file to SQLite format.
- ``-ot, --output-type {json,csv,tsv,sqlite}``: The output file type.
Loading