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

api files and doc source files pre-commit fix #1135

Closed
wants to merge 4 commits into from

Conversation

stevenhua0320
Copy link
Contributor

Merge these api files and doc source dir pre-commit check files

@sbillinge sbillinge changed the base branch from main to api July 18, 2024 15:26
@sbillinge
Copy link
Contributor

I change this PR so it is into a different branch called api.

Do you have an idea about how we can test this? Can you build this and then compare the api docs side-by-side by with the online ones?

@stevenhua0320
Copy link
Contributor Author

I change this PR so it is into a different branch called api.

Do you have an idea about how we can test this? Can you build this and then compare the api docs side-by-side by with the online ones?

Is that mean we need to check whether these built api contains all the info that currently the online ones have?

@sbillinge
Copy link
Contributor

I change this PR so it is into a different branch called api.
Do you have an idea about how we can test this? Can you build this and then compare the api docs side-by-side by with the online ones?

Is that mean we need to check whether these built api contains all the info that currently the online ones have?

yes, that's right. It can be in a different order, it doesn't have to be identical, and there can be additional information (which would be good), but just check that none of the current information is lost.

@sbillinge sbillinge deleted the branch regro:api July 20, 2024 07:24
@sbillinge sbillinge closed this Jul 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants