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

Add CLI Documentation to Scribe-Data .rst File for list and total commands #332

Merged
merged 4 commits into from
Oct 12, 2024
Merged

Add CLI Documentation to Scribe-Data .rst File for list and total commands #332

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e9f6ee2
Update cli.rst added the complete processes and outputs for list comm…
KesharwaniArpita Oct 12, 2024
885826a
Merge branch 'scribe-org:main' into AK-Documentation
KesharwaniArpita Oct 12, 2024
166ba19
Update cli.rst added the complete processes and outputs for total com…
KesharwaniArpita Oct 12, 2024
a8a9e4f
Minor edits to CLI docs - shorten outputs / examples
andrewtavis Oct 12, 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
74 changes: 67 additions & 7 deletions docs/source/scribe_data/cli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,16 +54,68 @@ Example output:
.. code-block:: text

$ scribe-data list

Language ISO QID
-----------------------
English en Q1860
...
-----------------------

Available data types: All languages
-----------------------------------
adjectives
adverbs
emoji-keywords
nouns
prepositions
translations
verbs
-----------------------------------



.. code-block:: text

$scribe-data list --language

Language ISO QID
-----------------------
English en Q1860
French fr Q150
German de Q188
...
-----------------------


.. code-block:: text

$scribe-data list -dt

Available data types: All languages
-----------------------------------
adjectives
adverbs
emoji-keywords
nouns
prepositions
translations
verbs
-----------------------------------


.. code-block:: text

$scribe-data list -a

Language ISO QID
-----------------------
English en Q1860
...
-----------------------

Available data types: All languages
-----------------------------------
adjectives
adverbs
emoji-keywords
nouns
prepositions
translations
Expand Down Expand Up @@ -197,14 +249,22 @@ Examples:

.. code-block:: text

$ scribe-data total -dt nouns
$scribe-data total -dt nouns # verbs, adjectives, etc
Data type: nouns
Total number of lexemes: <NUMBER />
Total number of lexemes: 123456

.. code-block:: text

$scribe-data total -lang English
Language: English
Total number of lexemes: 123456

.. code-block:: text

$ scribe-data total -lang eng -dt nouns
Language: eng
$scribe-data total -lang English -dt nouns
Language: English
Data type: nouns
Total number of lexemes: <NUMBER />
Total number of lexemes: 12345

Convert Command
~~~~~~~~~~~~~~~
Expand Down
Loading