Updates to the documentation to reflect the refactored CLI #93
Conversation
Codecov Report
@@ Coverage Diff @@
## dev.cli #93 +/- ##
========================================
Coverage 75.64% 75.64%
========================================
Files 26 26
Lines 1601 1601
Branches 284 284
========================================
Hits 1211 1211
Misses 347 347
Partials 43 43
Continue to review full report at Codecov.
|
|
|
||
| ## Build the documentation locally | ||
|
|
||
| To build the documention for local inspection, run one of these commands, |
There was a problem hiding this comment.
I really like this section @joanise - great addition.
|
|
||
| Silences are inserted in the audio stream wherever a ``silence`` element is | ||
| found in the XML input. | ||
| **TODO say something about how the silence placement determined.** |
There was a problem hiding this comment.
Do we want to merge this with the TODOs? Or did you put these here for me to fill out?
There was a problem hiding this comment.
@roedoejet Actually, Marc has reported errors in where silences are inserted, especially when there are anchors next to silences. Short answer, yes, I'd like you to fill this in. I'll merge it into dev.cli as is, but it a TODO for you, in conjunction with fixing #89 and Marc's reported silence placement issues.
readalongs/cli.py
Outdated
| "The language code(s) for text in TEXTFILE (use only with -i, i.e., with plain text input); " | ||
| "multiple codes can be joined by ':' or by repeating the option; " | ||
| "The language code(s) for text in TEXTFILE (use only with plain text input); " | ||
| "multiple codes can be joined by ':', or by repeating the option, to enable the g2p cascade; " |
There was a problem hiding this comment.
Link to g2p cascade docs here
There was a problem hiding this comment.
Yeah, that would be important. I'm not quite sure how best to do it...
I could link to readthedocs, but I don't really like that to be the main source. I'm inclined to put a paragraph about the g2p cascade in the def align docstring, so it's in the body of g2p align -h, refer to that in the -l switch doc for both align and prepare.
Hmm, I see I documented the cascade in readalongs g2p -h. I'll need to think this through more carefully and do something coherent in g2p, prepare and align... Maybe all I need is something like (run 'readalongs g2p -h' for details).
readalongs/cli.py
Outdated
| @@ -416,7 +416,7 @@ def align(**kwargs): | |||
| callback=joiner_callback(LANGS), | |||
| help=( | |||
| "The language code(s) for text in PLAINTEXTFILE; " | |||
| "multiple codes can be joined by ':' or by repeating the option; " | |||
| "multiple codes can be joined by ':', or by repeating the option, to enable the g2p cascade; " | |||
The dev.cli branch makes a lot of changes to the CLI for readalongs. This PR updates docs/ to reflect all those changes.
It's meant to be fast-forward merged into dev.cli (via the git CLI, not via GitHub) once we're happy with it.