Skip to content

Commit

Permalink
Add updated files from build
Browse files Browse the repository at this point in the history
  • Loading branch information
ejm714 authored and actions-user committed Mar 23, 2022
1 parent 637c6eb commit 7de1453
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 14 deletions.
9 changes: 2 additions & 7 deletions README.md
Expand Up @@ -140,28 +140,23 @@ Usage: deon [OPTIONS]
Easily create an ethics checklist for your data science project.
The checklist will be printed to standard output by default. Use the
--output option to write to a file instead.
The checklist will be printed to standard output by default. Use the --output
option to write to a file instead.
Options:
-l, --checklist PATH Override default checklist file with a path to a custom
checklist.yml file.
-f, --format TEXT Output format. Default is "markdown". Can be one of
[ascii, html, jupyter, markdown, rmarkdown, rst].
Ignored and file extension used if --output is passed.
-o, --output PATH Output file path. Extension can be one of [.txt, .html,
.ipynb, .md, .rmd, .rst]. The checklist is appended if
the file exists.
-w, --overwrite Overwrite output file if it exists. Default is False,
which will append to existing file.
-m, --multicell For use with Jupyter format only. Write checklist with
multiple cells, one item per cell. Default is False,
which will write the checklist in a single cell.
--help Show this message and exit.
```
Expand Down
9 changes: 2 additions & 7 deletions docs/docs/index.md
Expand Up @@ -133,28 +133,23 @@ Usage: deon [OPTIONS]
Easily create an ethics checklist for your data science project.
The checklist will be printed to standard output by default. Use the
--output option to write to a file instead.
The checklist will be printed to standard output by default. Use the --output
option to write to a file instead.
Options:
-l, --checklist PATH Override default checklist file with a path to a custom
checklist.yml file.
-f, --format TEXT Output format. Default is "markdown". Can be one of
[ascii, html, jupyter, markdown, rmarkdown, rst].
Ignored and file extension used if --output is passed.
-o, --output PATH Output file path. Extension can be one of [.txt, .html,
.ipynb, .md, .rmd, .rst]. The checklist is appended if
the file exists.
-w, --overwrite Overwrite output file if it exists. Default is False,
which will append to existing file.
-m, --multicell For use with Jupyter format only. Write checklist with
multiple cells, one item per cell. Default is False,
which will write the checklist in a single cell.
--help Show this message and exit.
```
Expand Down

0 comments on commit 7de1453

Please sign in to comment.