Create documentation about layer artists #814
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@ChrisBeaumont - while working on this, I ran across a couple of things in the API that would be nice to update:
DataViewer._container
: this name is pretty obscure, and it should maybe instead beDataViewer._layer_artists
orDataViewer._layer_artist_container
..artists
vs_container
for the same object, andartist_container
in some kwargs). What about.layer_artists
, and make it public for both clients and widgets?layer
variable which really is the layer data. Would you have any objections to me renaminglayer
tolayer_data
? So then we'd never have just 'layer' - either layer artist or layer data.What do you think?
Side note: at the moment, we don't really talk about the possibility of using clients in these docs - and that's because in principle one doesn't have to use a separate client class. Before writing docs on how to better separate client functionality and GUI, I think it would be good to converge on a solution in #775 first, so adding details of clients to the page here is low priority for now in my view.
@PennyQ - just for info, I've started working on this, but it's by no means complete. I'll work on it more over the next couple of days (in my spare time).