Skip to content

Fix ToLinen docstring return description #4852

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

Merged
merged 1 commit into from
Aug 11, 2025

Conversation

mohsinm-dev
Copy link
Contributor

What does this PR do?

Summary

Fixes the incorrect docstring in the ToLinen class.

Changes

  • Fixed the "Returns" section in ToLinen docstring
  • Changed from "A stateful NNX module that behaves the same as the wrapped Linen module"
  • To "A Linen module that behaves the same as the wrapped NNX module"

Issue

  • ToLinen: Wraps NNX module → returns Linen module
  • ToNNX: Wraps Linen module → returns NNX module

The docstring was incorrectly copied from ToNNX and not updated properly.

Fixes #4803

Checklist

  • This PR fixes a minor issue (e.g.: typo or small bug) or improves the docs (you can dismiss the other
    checks if that's the case).
  • This change is discussed in a Github issue/
    discussion (please add a
    link).
  • The documentation and docstrings adhere to the
    documentation guidelines.
  • This change includes necessary high-coverage tests.
    (No quality testing = no merge!)

Copy link

google-cla bot commented Jul 27, 2025

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

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

Thanks @mohsinm-dev !

@copybara-service copybara-service bot merged commit 087c95a into google:main Aug 11, 2025
17 checks passed
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.

Docstring for flax.nnx.bridge.ToLinen is incorrect
2 participants