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

docs: Added usage instructions to the docs #47

Merged
merged 2 commits into from
Dec 7, 2023
Merged

docs: Added usage instructions to the docs #47

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a136c6
Added usage instructions to the README.md
Masara Dec 7, 2023
2f4507b
Adjusted usage instructions to the README.md
Masara Dec 7, 2023
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
23 changes: 23 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,29 @@ Get the latest version from [PyPI](https://pypi.org/project/safe-ds-stubgen):
pip install safe-ds-stubgen
```

## Usage

To run this program:

```txt
usage: safe-ds-stubgen [-h] [-v] -p PACKAGE [-s SRC] -o OUT [--docstyle {PLAINTEXT,EPYDOC,GOOGLE,NUMPYDOC,REST}] [-tr] [-nc]

Analyze Python code.

options:
-h, --help show this help message and exit
-v, --verbose show info messages
-p PACKAGE, --package PACKAGE
The name of the package.
-s SRC, --src SRC Directory containing the Python code of the package. If this is omitted, we try to locate the package with the given name in the current Python interpreter.
-o OUT, --out OUT Output directory.
--docstyle {PLAINTEXT,EPYDOC,GOOGLE,NUMPYDOC,REST}
The docstring style.
-tr, --testrun Set this flag if files in /test or /tests directories should be included.
-nc, --naming_convert
Set this flag if the name identifiers should be converted to Safe-DS standard (UpperCamelCase for classes and camelCase for everything else).
```

## Documentation

You can find the full documentation [here](https://stubgen.safeds.com).
Expand Down