Skip to content

document the structure of trace modules #66

Closed
@alexcjohnson

Description

@alexcjohnson
Collaborator

Motivated by #63 ... we should describe this structure somewhere in the contributor's guide. What's generally supposed to be the role of attributes, supplyDefaults, supplyLayoutDefaults, calc, setPositions, plot, and style (anything else?), how to tell the difference, and when each of them gets called. Without that it's pretty hard for new people to make any meaningful contributions to the drawing code. The non-trace modules (axes, annotations, etc...) may still be too ad-hoc for this kind of doc to be useful, but I think the traces are fairly uniform by now.

Of course if this leads us to the desperately needed refactor & modularization of restyle and relayout I wouldn't complain, but that shouldn't stop us from documenting what we have.

Activity

etpinard

etpinard commented on Dec 3, 2015

@etpinard
Contributor

the gl trace modules need a convert step too at the moment.

self-assigned this
on Feb 27, 2020
etpinard

etpinard commented on Mar 3, 2020

@etpinard
Contributor

I'll try to make a PR for this ticket before I go.

@archmoj is there anything in particular regarding the trace module structure that you'd like me to write on?

archmoj

archmoj commented on Mar 4, 2020

@archmoj
Contributor

It would be helpful to know "when each of them gets called".

etpinard

etpinard commented on Mar 5, 2020

@etpinard
Contributor

TODO:

  • (not really related this to, but something I should write about) how to debugger in jasmine test window to write interaction tests faster.
etpinard

etpinard commented on Mar 11, 2020

@etpinard
Contributor

Peek 2020-03-11 10-45

⬆️ gif I'll add to the CONTRIBUTING.md doc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    Participants

    @alexcjohnson@etpinard@archmoj

    Issue actions

      document the structure of trace modules · Issue #66 · plotly/plotly.js