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

Autodoc issue #4260

Closed
jorivanee opened this issue Nov 24, 2017 · 1 comment
Closed

Autodoc issue #4260

jorivanee opened this issue Nov 24, 2017 · 1 comment

Comments

@jorivanee
Copy link

Subject: Autodoc issue

Problem

Procedure to reproduce the problem

class BotDescription:
	"""Represents a DBL Bot Description

	Attributes
	----------
	short: str
		The bot's short description.
	long: str
		The bot's long description.
	"""
	def __init__(self, *, data={}):
		self.long = None
		self.short = None
		self.update(data=data)

	def update(self, *, data):
		longdesc = data.get("longdesc",None)
		shortdesc = data.get("shortdesc",None)
		if shortdesc:
			self.short = shortdesc
		if longdesc:
			self.long = longdesc

Error logs / results

Nothing
  • Nothing

Expected results

Not display (*, data={})

Reproducible project / your project

Environment info

  • OS: Windows
  • Python version: 3.6.1
  • Sphinx version: 1.6.2
@tk0miya tk0miya added this to the 1.7.1 milestone Feb 12, 2018
tk0miya added a commit to tk0miya/sphinx that referenced this issue Feb 12, 2018
tk0miya added a commit to tk0miya/sphinx that referenced this issue Feb 12, 2018
tk0miya added a commit to tk0miya/sphinx that referenced this issue Feb 12, 2018
tk0miya added a commit that referenced this issue Feb 14, 2018
…ared

Fix #4260: autodoc: keyword only argument separator is not disappeared
@tk0miya
Copy link
Member

tk0miya commented Feb 14, 2018

Fixed by #4599.
Thank you for reporting!

@tk0miya tk0miya closed this as completed Feb 14, 2018
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 19, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants