Skip to content

document the structure of trace modules #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
alexcjohnson opened this issue Dec 3, 2015 · 5 comments · Fixed by #4624
Closed

document the structure of trace modules #66

alexcjohnson opened this issue Dec 3, 2015 · 5 comments · Fixed by #4624
Assignees

Comments

@alexcjohnson
Copy link
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.

@etpinard
Copy link
Contributor

etpinard commented Dec 3, 2015

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

@etpinard
Copy link
Contributor

etpinard commented Mar 3, 2020

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
Copy link
Contributor

archmoj commented Mar 4, 2020

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

@etpinard
Copy link
Contributor

etpinard commented Mar 5, 2020

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
Copy link
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
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants