Update text docs #389
Merged
Update text docs #389
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add documentation for `minimum_views` value on the transription reducers. This value is passed along to the fron-end and has no effect on the reduction results. I think any further documentation for how the front-end uses this value should belong with the front-end code so can stay up to date if it ever changes. Happy to link to the documenation from here if a link exists.
There wre a few places where `---` did not extend fare enough. Python's doc string syntax can be a bit verbose at times...
CKrawczyk
force-pushed
the
update-text-docs
branch
from
5267677
to
5bb9bb1
Compare
lcjohnso
approved these changes
Dec 10, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation for
minimum_viewsvalue on the transcription reducers. This value is passed along to the front-end and has no effect on the reduction results. I think any further documentation for how the front-end uses this value should belong with the front-end code so can stay up to date if it ever changes.Happy to link to the documentation from here if a link exists.
Closes #387