Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Altair widget names should reflect API #59

Open
2 tasks
rolyp opened this issue Nov 12, 2021 · 0 comments
Open
2 tasks

Altair widget names should reflect API #59

rolyp opened this issue Nov 12, 2021 · 0 comments
Assignees
@edwardchalstrey1
Labels
documentation Improvements or additions to documentation proposed
Milestone
Minimal Project c...

Comments

@rolyp
Copy link
Collaborator

rolyp commented Nov 12, 2021

One way of understanding the Altair widgets is to think of them as a visualisation of the options provided the library. So it probably makes sense to make that connection explicit by naming things appropriately. Then the widgets serve as "interactive documentation" of (a subset of) the functionality offered by the library.

  • widgets should use same/similar names to API parameters
  • rename meta_hist to something like alt_color
@edwardchalstrey1 edwardchalstrey1 self-assigned this Dec 2, 2021
@rolyp rolyp added documentation Improvements or additions to documentation and removed feature labels Dec 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@edwardchalstrey1 edwardchalstrey1

Labels
documentation Improvements or additions to documentation proposed
Projects
None yet
Milestone
Minimal Project completion goals
Development

No branches or pull requests
2 participants
@rolyp @edwardchalstrey1