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.

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

[chore][docs] enable Markdown lint rule MD036 #3137

Merged
merged 1 commit into from
Mar 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion .markdownlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,5 @@ default: true

MD013: false
MD024: false
MD036: false
MD050: false
MD052: false
29 changes: 8 additions & 21 deletions clients/python-client/python_client_test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,22 @@

## For developers

make sure you have installed setuptool
1. `pip install -U pip setuptools`
1. `cd clients/python-client && pip install -e .`

`pip install -U pip setuptools`

**run the pip command**

from the directory `path/to/kuberay/clients/python-client`

`pip install -e .`

**to uninstall the module run**

`pip uninstall python-client`
Uninstall with `pip uninstall python-client`.

## For testing run

`python -m unittest discover 'path/to/kuberay/clients/python-client/python_client_test/'`
`python -m unittest discover 'clients/python-client/python_client_test/'`

### Coverage report

__install prerequisites__

`sudo apt install libsqlite3-dev`

`pip3 install db-sqlite3`

`pyenv install 3.6.5` # or your Python version
#### Pre-requisites

`pip install coverage`
* `sudo apt install libsqlite3-dev`
* `pyenv install 3.6.5` # or your Python version
* `pip install db-sqlite3 coverage`

__To gather data__
`python -m coverage run -m unittest`
Expand Down
Loading