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

Jump to bottom

fix(bindings/python): Fix the test command in doc #3541

Merged
merged 1 commit into from
Nov 9, 2023
Merged

fix(bindings/python): Fix the test command in doc #3541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion bindings/python/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@ OpenDAL adopts `pytest` for behavior tests:

```shell
maturin develop -E test
OPENDAL_MEMORY_TEST=on pytest -vk TestMemory
# To run `test_write.py` and use `fs` operator
OPENDAL_TEST=fs opendal_fs_root=/tmp pytest -vk test_write
```

## Docs
Expand Down
3 changes: 2 additions & 1 deletion bindings/python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ Run some tests:

```shell
maturin develop -E test
OPENDAL_MEMORY_TEST=on pytest -vk TestMemory
# To run `test_write.py` and use `fs` operator
OPENDAL_TEST=fs opendal_fs_root=/tmp pytest -vk test_write
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, @Justin-Xiang, it's better to use OPENDAL_FS_ROOT to align with other parts.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Xuanwo Get it, should I open a PR directly or an issue?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should I open a PR directly

I think it's simple and can be finished in a PR directly. Thanks for the fix!

```

Build API docs:
Expand Down