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

Refresh and solicit feedback on vignettes #14

Closed
7 tasks done
jimjam-slam opened this issue Jul 10, 2019 · 0 comments
Closed
7 tasks done

Refresh and solicit feedback on vignettes #14

jimjam-slam opened this issue Jul 10, 2019 · 0 comments
Labels
good first issue Good for newcomers

Comments

@jimjam-slam
Copy link
Owner

jimjam-slam commented Jul 10, 2019

As well as scanning the docs to ensure they're still current for 0.5.1, I need to rewrite the vignettes and see how readable they are. The current one could use some work, and I'd like to split up vignette topics (or sections) around these ideas:

  • Intro to list columns and associated workflows
  • Collateral basics:
    • What am I looking at?
    • Extracting side effects
  • More advanced workflows
    • Filtering on and summarising side effects
    • Successive operations with collateral

I'd really like to work out coloured output first, but I probably shouldn't make it a must.

Of course, if someone wants to take a swing at this, I'd be happy to accept a PR!

@jimjam-slam jimjam-slam added the good first issue Good for newcomers label Jul 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant