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

fix: fix parameters not showing in doc bug #2270

Conversation

yuejiaointel
Copy link
Contributor

@yuejiaointel yuejiaointel commented Jan 23, 2025

Description

Hi to whom is reviewing this PR!
This PR fixed a bug in documentation generation where the Parameters section under all classes are missing. The root problem was because the template in wrapper_gen.py was putting cdef tuple _params above the parameters doc strings. As a result, sphinx cannot extract the docstring out and parameters under all classes are missing. The fix was a simple one line change that put docstring on top. The doc pipeline in this branch does not work, fixed in another PR that has not been merged yet. To see the effect, either get the branch or try out the one line change.
Best,
Yue


PR should start as a draft, then move to ready for review state after CI is passed and all applicable checkboxes are closed.
This approach ensures that reviewers don't spend extra time asking for regular requirements.

You can remove a checkbox as not applicable only if it doesn't relate to this PR in any way.
For example, PR with docs update doesn't require checkboxes for performance while PR with any change in actual code should have checkboxes and justify how this code change is expected to affect performance (or justification should be self-evident).

Checklist to comply with before moving PR from draft:

PR completeness and readability

  • I have reviewed my changes thoroughly before submitting this pull request.
  • I have commented my code, particularly in hard-to-understand areas.
  • Git commit message contains an appropriate signed-off-by string (see CONTRIBUTING.md for details).
  • I have added a respective label(s) to PR if I have a permission for that.
  • I have resolved any merge conflicts that might occur with the base branch.

Testing

  • I have run it locally and tested the changes extensively.
  • All CI jobs are green or I have provided justification why they aren't.
  • I have extended testing suite if new functionality was introduced in this PR.

Copy link

codecov bot commented Jan 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Flag Coverage Δ
azure 78.04% <ø> (ø)
github 71.06% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@yuejiaointel yuejiaointel marked this pull request as ready for review January 24, 2025 00:32
@icfaust
Copy link
Contributor

icfaust commented Jan 24, 2025

/azp run Docs

Copy link

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

Copy link
Contributor

@icfaust icfaust left a comment

Choose a reason for hiding this comment

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

Was hoping I could get the docs to run on this, but it seems that azure pipelines is being uncooperative.

@yuejiaointel yuejiaointel merged commit 058372f into uxlfoundation:main Jan 24, 2025
31 of 32 checks passed
@yuejiaointel yuejiaointel deleted the fix_autoclass_document_constructor branch January 24, 2025 18:20
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.

3 participants