[Notes] [Git][BuildStream/buildstream][master] CONTRIBUTING.rst: Added note about sphinx supporting docstrings on instance variables

[Tristan Van Berkom <gitlab mg gitlab com>]

Title: GitLab

Tristan Van Berkom pushed to branch master at BuildStream / buildstream

Commits:

• 885bd946
  by Tristan Van Berkom at 2018-10-09T09:39:24Z

  CONTRIBUTING.rst: Added note about sphinx supporting docstrings on instance variables
  
  Python does not natively support this, but sphinx does parse them and includes
  these in the generated documentation.
  

1 changed file:

• CONTRIBUTING.rst

Changes:

CONTRIBUTING.rst

---

...	...	@@ -270,6 +270,11 @@ comments and docstrings.
270	270	*Since: 1.2*
271	271	"""
272	272
	273	+.. note::
	274	+
	275	+ Python does not really support docstrings on instance variables, but
	276	+ sphinx does pick them up includes them in the generated documentation.
	277	+
273	278	**Internal instance variable**::
274	279
275	280	def __init__(self, context, element):

—
View it on GitLab.
You're receiving this email because of your account on gitlab.com. If you'd like to receive fewer emails, you can adjust your notification settings.