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

Some Headings in Napolean Style Docstrings Rendered Improperly #4

Open
rmorshea opened this issue Nov 10, 2018 · 0 comments
Open

Some Headings in Napolean Style Docstrings Rendered Improperly #4

rmorshea opened this issue Nov 10, 2018 · 0 comments

Comments

@rmorshea
Copy link

Certain headings like "Examples" and "Notes" in napolean style docstrings render as normal text instead of headings. For example the following the docstring:

def half(x):
    """Divide a number in half

    Parameters
    ----------
    x : int
        Number to be halfed

    Examples
    --------
    >>> assert half(10) == 5
    """
    return x / 2

Renders as...

bad-material-design-render-headings

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