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 examples for each pattern #17

Closed
iluxonchik opened this issue Oct 31, 2015 · 3 comments
Closed

Add examples for each pattern #17

iluxonchik opened this issue Oct 31, 2015 · 3 comments
Labels
C-enhancement Category: Enhancements to content C-needs discussion Area: Something that is not clear to everyone if it fixes something/adds valuable content
Projects

Comments

@iluxonchik
Copy link

In my opinion, it would be usueful to include at least one concrete example of each pattern at the end of the file. It shouldn't be anything complicated, just something that gives the "feel" of the practical usage.

@nrc
Copy link
Collaborator

nrc commented Nov 2, 2015

The patterns already include an example, do you want something more concrete like an actual real-life use rather than a toy example?

@iluxonchik
Copy link
Author

The patterns already include an example

True, but it's just a template.

No, I mean a toy example, but with code that'll actually compile. Like, give a little intro text to give an intuition of where the pattern might be used. This will specially be helpful for someone who's just beginning with rust.

As an example, you can check how the Builder pattern is presented in Effective Java, 2nd Edition book. I will try to make some pull requests this week to show you what I mean.

@simonsan simonsan added C-enhancement Category: Enhancements to content C-needs discussion Area: Something that is not clear to everyone if it fixes something/adds valuable content labels Dec 31, 2020
@simonsan simonsan added this to To do in Content Jan 3, 2021
@simonsan
Copy link
Collaborator

simonsan commented Jan 4, 2021

We are running CI with mdbook test over the whole example section of the book. I rechecked it, and each pattern and/or idiom has examples. Every future article submitted with a PR will have an example by convention. Closing this issue therefore.

@simonsan simonsan closed this as completed Jan 4, 2021
Content automation moved this from To do to Done Jan 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: Enhancements to content C-needs discussion Area: Something that is not clear to everyone if it fixes something/adds valuable content
Projects
Development

No branches or pull requests

3 participants