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

SmartProcessor doesn't identify sphinx docstrings with arg or argument keywords #221

Closed
gmarks2149 opened this issue Oct 20, 2021 · 0 comments
Assignees
Labels

Comments

@gmarks2149
Copy link
Contributor

Environment

  • Pydoc-Markdown Version: 4.3.2
  • Python Version: v3.8.12
  • Operating System: Linux

Describe the bug

If the smart processor is used to identify the docstring for a docstring using the sphinx style, it won't properly recognize the sphinx style if the keywords used to describe the parameters are the "arg" or "argument" keywords. This is the case only if none of the other indicator keywords are present in the docstring.

Example

def find(name: str):
    """Find something

    :arg name: The name to find
    """
    pass

Produces this output...

``` python
def find(name: str)
``` 

Find something

:arg name: The name to find

Expected behavior

The smart processor should identify this a sphinx style docstring and process it correctly accordingly.

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

No branches or pull requests

2 participants