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

Add more examples to documentation #32

Open
tcbrindle opened this issue Jan 29, 2017 · 2 comments
Open

Add more examples to documentation #32

tcbrindle opened this issue Jan 29, 2017 · 2 comments

Comments

@tcbrindle
Copy link
Contributor

While the reference documentation is comprehensive, it would be very handy to have some high-level examples of what the library can do and why I would want to use it.

For example, Howard Hinnant's excellent date library has a page of "examples and recipes" available in its wiki.

@tahonermann
Copy link
Owner

I agree this would be nice to have. The only examples I've posted so far are those in the overview section of the readme (https://github.com/tahonermann/text_view#overview). Do you have any suggestions for good examples? The current feature set is pretty limited (I plan to start working on new features in the next couple of weeks), and I have struggled to come up with interesting examples because of that. Any chance you would be interested in drafting some wiki pages?

@tahonermann
Copy link
Owner

Hi Tristan. I finally got around to throwing together a few wiki pages loosely following Howard's work as you suggested. Does this match what you had in mind? Any suggestions for improving it would be welcome.

https://github.com/tahonermann/text_view/wiki

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

No branches or pull requests

2 participants