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 union type annotations for autodoc+mock-import rendering #8956

Merged
merged 6 commits into from
Apr 22, 2024

Conversation

pzelasko
Copy link
Collaborator

@pzelasko pzelasko commented Apr 17, 2024

What does this PR do ?

Sphinx's autodoc with mocked imports cannot handle a | b typing syntax when one of the arguments is a forward reference (used by autodoc to substitute imported classes). Introducing forward references also brakes the type dispatch mechanism in @singledispatch. I used the opportunity to fix a few other obvious errors that I saw in the long list of sphinx warnings.

Collection: ASR

Changelog

  • Fix for documentation build of ASR collection.

Usage

  • You can potentially add a usage example below
# Add a code snippet demonstrating how to use this 

Jenkins CI

To run Jenkins, a NeMo User with write access must comment jenkins on the PR.

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you add or update any necessary documentation?
  • Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
    • Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

  • New Feature
  • Bugfix
  • Documentation

If you haven't finished some of the above items you can still open "Draft" PR.

Who can review?

Anyone in the community is free to review the PR once the checks have passed.
Contributor guidelines contains specific people who can review PRs to various areas.

Additional Information

  • Related to # (issue)

@pzelasko
Copy link
Collaborator Author

jenkins

Copy link
Collaborator

@erastorgueva-nv erastorgueva-nv left a comment

Choose a reason for hiding this comment

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

LGTM, thank you

@pzelasko pzelasko merged commit b53c4b8 into main Apr 22, 2024
128 checks passed
@pzelasko pzelasko deleted the fix-docs-uniontype branch April 22, 2024 14:06
xingyaoww pushed a commit to xingyaoww/NeMo that referenced this pull request Apr 23, 2024
…8956)

Signed-off-by: Piotr Żelasko <[email protected]>
Co-authored-by: Pablo Garay <[email protected]>
Co-authored-by: Elena Rastorgueva <[email protected]>
alxzhang-amazon pushed a commit to alxzhang-amazon/NeMo that referenced this pull request Apr 26, 2024
…8956)

Signed-off-by: Piotr Żelasko <[email protected]>
Co-authored-by: Pablo Garay <[email protected]>
Co-authored-by: Elena Rastorgueva <[email protected]>
galv pushed a commit to galv/NeMo that referenced this pull request Apr 29, 2024
…8956)

Signed-off-by: Piotr Żelasko <[email protected]>
Co-authored-by: Pablo Garay <[email protected]>
Co-authored-by: Elena Rastorgueva <[email protected]>
suiyoubi pushed a commit that referenced this pull request May 2, 2024
Signed-off-by: Piotr Żelasko <[email protected]>
Co-authored-by: Pablo Garay <[email protected]>
Co-authored-by: Elena Rastorgueva <[email protected]>
Signed-off-by: Ao Tang <[email protected]>
rohitrango pushed a commit to rohitrango/NeMo that referenced this pull request Jun 25, 2024
…8956)

Signed-off-by: Piotr Żelasko <[email protected]>
Co-authored-by: Pablo Garay <[email protected]>
Co-authored-by: Elena Rastorgueva <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants