Skip to content

Support trailing parens in crossref title #40

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
analog-cbarber opened this issue Mar 30, 2025 · 0 comments
Open

Support trailing parens in crossref title #40

analog-cbarber opened this issue Mar 30, 2025 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@analog-cbarber
Copy link
Member

Sometimes people like to include parens when referring to a function or method call in a doc string, but
to do so using this package requires you to repeat the target name, e.g.:

def bar():
    """
    This function invokes [foo()][..foo]
    """

it would be nicer if we automatically ignored the trailing parens so that you could write:

def bar():
    """
    This function invokes [foo()][..]
    """

or even

def bar():
    """
    This function invokes [foo(x=42)][..]
    """
@analog-cbarber analog-cbarber self-assigned this Mar 30, 2025
@analog-cbarber analog-cbarber added the enhancement New feature or request label Mar 30, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant