Re: [BuildStream] Updated CONTRIBUTING.rst guide

[Angelos Evripiotis <angelos evripiotis gmail com>]

Heya!

Thanks for this, I think it’s super useful to have things laid out at this level of detail.

I’m not sure if this thread is the appropriate place for this particular q, but let’s see.

I was surprised that the Public API instance variable doc string works, as doc strings on variables are not a thing:

  self.name = self._compute_name(context, element)

  """The name of this foo

  *Since: 1.2*

  """

I think this is some sort of Sphinx magic. Please could a hint about how that works be included in the contributing guide if so, to save some time for dummies like me :)

Cheers!

Angelos