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

Embedded argument support for examples in libdoc #5140

Open
JFoederer opened this issue Jun 5, 2024 · 0 comments
Open

Embedded argument support for examples in libdoc #5140

JFoederer opened this issue Jun 5, 2024 · 0 comments

Comments

@JFoederer
Copy link
Contributor

When writing examples using libdoc, you typically want to use concrete examples with clarifying arguments. However, when you do that using embedded arguments, libdoc can no longer link the keyword to its definition.

Consider this snippet. The keyword from the example is not being linked:

@keyword("Shout ${n} cheers for")
def hurray(self, n:int, person:str):
    """Cheer them on as much as you like!
    
    Example:
    | `Shout 3 cheers for` | Robot |
    """
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

No branches or pull requests

1 participant