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

Setup doc testing for Python APIs #82

Open
xushiyan opened this issue Jul 19, 2024 · 4 comments
Open

Setup doc testing for Python APIs #82

xushiyan opened this issue Jul 19, 2024 · 4 comments
Assignees
@kazdy
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers p2 python Related to Python codebase test

Comments

@xushiyan
Copy link
Member

xushiyan commented Jul 19, 2024 •
edited
Loading

Doc test cases should serve as

  • guiding example to show users the most typical use cases of the APIs
  • actual test cases like other unit tests
@xushiyan xushiyan added good first issue Good for newcomers test p2 labels Jul 19, 2024
@xushiyan xushiyan added this to the release-0.3.0 milestone Jul 19, 2024
@kazdy
Copy link
Contributor

kazdy commented Oct 14, 2024 •
edited
Loading

@xushiyan I'm happy to contribute this

What do you expect from this, a few e2e doctests that show how to create and read from HudiTable ?

@xushiyan
Copy link
Member Author

@kazdy yup updated the description

@xushiyan xushiyan modified the milestones: release-0.3.0, release-0.4.0 Oct 14, 2024
@xushiyan
Copy link
Member Author

xushiyan commented Oct 14, 2024 •
edited
Loading

@kazdy I'd actually suggest do this after release 0.3 when we have more APIs to be covered, making docs testing more worthy. Right now the APIs are very preliminary (and subject to change)

@xushiyan xushiyan mentioned this issue Oct 14, 2024
Closed
@xushiyan
Copy link
Member Author

block this on #141

@xushiyan xushiyan removed this from the release-0.4.0 milestone Nov 30, 2024
@xushiyan xushiyan added this to the release-0.4.0 milestone Jan 23, 2025
@xushiyan xushiyan removed this from the release-0.4.0 milestone Feb 1, 2025
@xushiyan xushiyan added documentation Improvements or additions to documentation python Related to Python codebase labels Feb 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kazdy kazdy

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers p2 python Related to Python codebase test
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@xushiyan @kazdy