[GitHub] [buildstream] gtristan commented on issue #1641: Support source plugin configs with plugin YAML

[GitBox <gi...@apache.org>]

gtristan commented on issue #1641:
URL: https://github.com/apache/buildstream/issues/1641#issuecomment-1111772074

   > This makes documentable defaults basically impossible unless I'm missing something.
   
   Currently plugins (elements or sources) document themselves using reStructuredText in the module level docstring, e.g.: https://github.com/apache/buildstream-plugins/blob/master/src/buildstream_plugins/sources/git.py#L27
   
   The difference is only that plugin level defaults are not composited for source plugins. Element plugins have been using this file as a convenience at composition time, which is indeed nice and simple.
   
   We originally used this approach of plugin level yaml defaults for the sake of build elements especially, since they are mostly composed of yaml configuration (different build elements only differ in their yaml defaults) - while this is much less useful for source plugins, it could still be useful.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@buildstream.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org