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.

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

document #2

Open
timelyportfolio opened this issue Jun 30, 2020 · 4 comments
Open

document #2

timelyportfolio opened this issue Jun 30, 2020 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@timelyportfolio
Copy link
Owner

I believe the API is stable enough to begin documenting in roxygen and also in other supplementary materials, such as vignettes and articles.

@timelyportfolio timelyportfolio added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Jun 30, 2020
@JasonCurole
Copy link

@timelyportfolio are you still looking for support on this?

@timelyportfolio
Copy link
Owner Author

@JasonCurole yes definitely - documentation is the only obstacle between current state and CRAN. Happy to discuss.

@JasonCurole
Copy link

Great. Happy to help. I'm new to contributing, but I've been using dataui (both on its own and through reactablefmtr) and am very appreciative. Let me know the best way for us to discuss.

@timelyportfolio
Copy link
Owner Author

@JasonCurole thanks so much again for potentially helping. I forgot that I started documentation very similar to what I envision for the remaining componentss in dui_histogram and dui_sparkline. Would this be sufficient to establish a pattern that we might be able to use as a model for the components in components.R? Most of the arguments are in storybook | props table tab and/or in github repo readme. I remember not all of these are exactly correct or maybe even available, but I did not list these back when I was working on building the package.

Also, I think instead of ... as the arguments for components, an R user might benefit from named arguments similar to dui_sparkline arguments.

I started with dui_sparkbarseries in this commit as an example.

If you still have interest, document away :). Let me know how I can help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants