Skip to content

chore: clearer doc for python binding#3667

Merged
Zheaoli merged 1 commit intoapache:mainfrom
wcy-fdu:update_python_doc
Nov 24, 2023
Merged

chore: clearer doc for python binding#3667
Zheaoli merged 1 commit intoapache:mainfrom
wcy-fdu:update_python_doc

Conversation

@wcy-fdu
Copy link
Copy Markdown
Contributor

@wcy-fdu wcy-fdu commented Nov 24, 2023

💦
It's better to use s3 as an example in the documentation than fs.

@github-actions github-actions Bot added the releases-note/chore The PR has a title that begins with "chore" or changes other small things that hard to tell label Nov 24, 2023
@Zheaoli
Copy link
Copy Markdown
Member

Zheaoli commented Nov 24, 2023

I think maybe we don't need this doc change.

The fs service in demo is the most simple way to help people to understand the interface what we provide for the language binding as fast as they can. So I think it's not good for me change it to s3. The develoepr don't need to know anything about S3 when they use the opendal in first time.

BTW, you can see that there is fs demo in all of the language binding we provide.

WDYT @Xuanwo

Comment thread bindings/python/README.md Outdated
Copy link
Copy Markdown
Member

@Xuanwo Xuanwo left a comment

Choose a reason for hiding this comment

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

LGTM!

@Xuanwo
Copy link
Copy Markdown
Member

Xuanwo commented Nov 24, 2023

cc @Zheaoli, would you like to take another review?

@wcy-fdu
Copy link
Copy Markdown
Contributor Author

wcy-fdu commented Nov 24, 2023

I think maybe we don't need this doc change.

The fs service in demo is the most simple way to help people to understand the interface what we provide for the language binding as fast as they can. So I think it's not good for me change it to s3. The develoepr don't need to know anything about S3 when they use the opendal in first time.

BTW, you can see that there is fs demo in all of the language binding we provide.

WDYT @Xuanwo

I prefer to add a specific object store service in python doc because user may use python to write some CI or test scripts, so I add it.

Copy link
Copy Markdown
Member

@Zheaoli Zheaoli left a comment

Choose a reason for hiding this comment

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

LGTM

@Zheaoli Zheaoli merged commit 1c3e797 into apache:main Nov 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

releases-note/chore The PR has a title that begins with "chore" or changes other small things that hard to tell

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants