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.

Sign up for GitHub

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

Jump to bottom

>1 inline literals on 1 line causes description to disappear when built - Napoleon #8192

Closed
hmellor opened this issue Sep 10, 2020 · 0 comments
Closed

>1 inline literals on 1 line causes description to disappear when built - Napoleon #8192

hmellor opened this issue Sep 10, 2020 · 0 comments
Labels
extensions:napoleon type:bug
Milestone
3.3.0

Comments

@hmellor
Copy link

hmellor commented Sep 10, 2020

Describe the bug
Having multiple inline literals on the same line causes the description to not be included when building to HTML.

To Reproduce
Using the google template as an example.

Args:
    argument (``int``, optional): Placeholder argument. Defaults to ``4``.

Appears like this in HTML:

  • argument (int, optional) –

Expected behavior
The HTML should look like this:

  • argument (int, optional) – Placeholder argument. Defaults to 4.

Environment info

  • OS: Win
  • Python version: 3.8.5
  • Sphinx version: 3.1.2
  • Sphinx extensions: sphinx.ext.napoleon
@hmellor hmellor changed the title >1 inline literals on 1 line causes description to disappear when built >1 inline literals on 1 line causes description to disappear when built - Napoleon Sep 10, 2020
@tk0miya tk0miya added this to the 3.3.0 milestone Sep 10, 2020
@tk0miya tk0miya mentioned this issue Sep 10, 2020
Merged
tk0miya added a commit that referenced this issue Sep 12, 2020
@tk0miya
Merge pull request #8193 from tk0miya/8192_napoleon_removes_description
5b226b9 
Fix #8192: napoleon: description is disappeared by inline literals
@hmellor hmellor mentioned this issue Sep 25, 2020
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 19, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
extensions:napoleon type:bug
Projects
None yet
Milestone
3.3.0
Development

No branches or pull requests
2 participants
@tk0miya @hmellor