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

typehints_defaults = "braces-after" doesn't work correctly with multiline docstrings #384

Open
KareemMAX opened this issue Sep 4, 2023 · 1 comment
Assignees

Comments

@KareemMAX
Copy link

Currently we have this docstring

        Parameters
        ----------
        self
            input array.
        approximate
            whether to use the approximate version of the gelu function.
        complex_mode
            optional specifier for how to handle complex data types. See
            ``ivy.func_wrapper.handle_complex_input`` for more detail.
        out
            optional output array, for writing the result to. It must have a shape
            that the inputs broadcast to.

When we use typehints_defaults = "braces-after" it renders incorrectly for complex_mode:
image

The (default: 'jax') should be places at the end of line 2 (after "more details."), while it's currently places after line 1 (See).

@gaborbernat
Copy link
Member

PR welcome 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants