Add introduction #117

simonsan · 2021-01-01T13:47:13Z

Reviving the ghost PR #43

Regarding functional and refactoring folders:

Something that we might add to the issues:

I was thinking something similar to what exists in the patterns folder, probably with an altered template. So far my ideas are:
* `functional`
  
  * currying
  * higher-order functions
  * collections

* `refactoring`
  
  * refactoring from `unwrap` to `Result`
  * refactoring from `enum` to `Option`

Some point may still stand? Need to check.

Fixes #4

refactoring/README.md

patterns/README.md

intro.md

patterns/README.md

rust_rocks.md

intro.md

refactoring/README.md

README.md

anti_patterns/README.md

patterns/newtype.md

Co-authored-by: Marco Ieni <11428655+MarcoIeni@users.noreply.github.com>

simonsan · 2021-01-02T11:15:49Z

Nice!

functional/README.md

pickfire · 2021-01-02T16:56:23Z

idioms/README.md

+
+The computer understands the machine code that is generated by the compiler. The language is therefore mostly beneficial to the developer. So, since we have this abstraction layer, why not put it to good use and make it simple?
+
+Remember the [KISS principle](https://en.wikipedia.org/wiki/KISS_principle): "Keep It Simple, Stupid". It claims that "most systems work best if they are kept simple rather than made complicated; therefore, simplicity should be a key goal in design, and unnecessary complexity should be avoided".


This sounds like go to me. I feel like rust is aiming to be "keep it simple but not simpler".

Go is able to be simple by having tons of footguns as a result, simplicity matters more than correctness, it just aims to be correct enough.

Rust aims more to be correct than simple (this is why rust became so complicated), one good thing is that the footguns are reduced to bare minimum, this is what I believe how the API in rust is designed.

Maybe be should still mention that correctness should be valued before simplicity?

I strongly agree with you.

We can say something like:
"even if the kiss principle is important rust tends to prefer correctness over simplicity."

If you want to do a PR where you explain this it would be nice I think (you don't have to report my words necessarily).

pickfire · 2021-01-02T17:01:30Z

intro.md

+[Design patterns](patterns/README.md) are methods to solve common problems when writing software.
+
+[Anti-patterns](anti_patterns/README.md) are methods to solve these same common problems. 


Feels like the same wordings, maybe we should let readers know what are the differences between them? "Anti-patterns" is a tough english word, we should have more descriptions.

pickfire · 2021-01-02T17:03:45Z

patterns/README.md

+
+If we apply YAGNI to design patterns, we see that the features of Rust allow us to throw out many patterns. For instance, there is no need for the [strategy pattern](https://en.wikipedia.org/wiki/Strategy_pattern) in Rust because we can just use [traits](https://doc.rust-lang.org/book/traits.html).
+
+TODO: Maybe include some code to illustrate the traits.


I think we could remove this, I wonder if illustration is really needed here for understanding.

patterns/newtype.md

simonsan · 2021-01-02T17:05:28Z

@pickfire It's hard to deal with that feedback in a closed and merged PR. What do you think about changing the things directly in these files to your liking and create a new PR where we can discuss about your proposed changes? Would make it much easier to follow for everyone I think. Happy new year! ;)

pickfire · 2021-01-02T17:06:45Z

patterns/newtype.md

@@ -1,5 +1,9 @@
 # Newtype

+Rust has strong static types. This can be very different than what you are used to if you are coming from a loosely-typed language. Don't worry, though. Once you get used to them, you'll find the types actually make your life easier. Why? Because you are making implicit assumptions explicit.
+
+A really convenient application of the Rust type system is the Newtype pattern.


How is Newtype pattern convenient? I think we should use a different word other than convenient or maybe we should explain why is it convenient. Or maybe we could just

An application of the Rust type system is the Newtype pattern.

Or maybe we should have a better question or a problem as the introduction?

What if in some cases we want to have a type to behave similarly but still different to another type?

What if in some cases we want to have a type to behave similarly but still different to another type?

I like this :)

refactoring/README.md

pickfire · 2021-01-03T15:12:17Z

@pickfire It's hard to deal with that feedback in a closed and merged PR. What do you think about changing the things directly in these files to your liking and create a new PR where we can discuss about your proposed changes? Would make it much easier to follow for everyone I think. Happy new year! ;)

Happy new year!

I wish there is more time gap since I am interested to help review these too (of course only those that I am able to). I see that by the time I read it (within 1 or 2 day time) it was already merged. @simonsan How did you get to be the maintainer here? I remember that it wasn't active for a while and then you suddenly come and change.

simonsan · 2021-01-03T15:37:22Z

I wish there is more time gap since I am interested to help review these too (of course only those that I am able to). I see that by the time I read it (within 1 or 2 day time) it was already merged.

This PR was a ghost PR from October 2016, most of the PRs, beside the repository structure we are changing like setting up CI or creating a book, were relatively old PRs. We want to work down the list and create a great learning resource for the community with it because imho this is excellent content and it will get even better with more people participating in the future. The other left over PRs are much bigger topics than the ones that were merged, so there will be a timegap for sure. I'm thankful as well, if there are more eyes on it with reviews, please feel free to review them as well. The velocity will slow down soonish, as we handled most of the open PRs already.

@simonsan How did you get to be the maintainer here? I remember that it wasn't active for a while and then you suddenly come and change.

I think this is a good collection of what happened and an actual status:
https://www.reddit.com/r/rust/comments/kowtqn/rust_design_patterns_now_also_as_a_book/

Cheers ;-)

MarcoIeni · 2021-01-03T22:01:34Z

Pickfire, feel free to leave a comment on a pr if you want to review it and we will wait for your review, even for different days, no problem!
Right now I'm overwhelmed by github notifications, so any help is HIGHLY appreciated! :)

Me and simonsan requested maintainer rights in #107 by the way

simonsan mentioned this pull request Jan 1, 2021

Add introduction #43

Closed

Revive ghost from #43

da179df

simonsan force-pushed the add-introduction branch from d1722cb to da179df Compare January 1, 2021 13:53

simonsan added 2 commits January 1, 2021 14:57

Layout of intro

2c01b29

Adding newly committed files to SUMMARY.md

28f790c

simonsan requested a review from MarcoIeni January 1, 2021 14:06

MarcoIeni reviewed Jan 1, 2021

View reviewed changes

refactoring/README.md Outdated Show resolved Hide resolved

MarcoIeni reviewed Jan 1, 2021

View reviewed changes

patterns/README.md Outdated Show resolved Hide resolved

simonsan added 4 commits January 1, 2021 16:14

Refactor to single lines

4e3c465

Removing older content from intro

b7a05d8

Remove overview in patterns/README.md

b0bc4f9

Fix from review, newlines for quotes

7a9dc4b

MarcoIeni reviewed Jan 1, 2021

View reviewed changes

intro.md Outdated Show resolved Hide resolved

MarcoIeni reviewed Jan 1, 2021

View reviewed changes

patterns/README.md Outdated Show resolved Hide resolved

Fix from review

4a320f8

MarcoIeni reviewed Jan 1, 2021

View reviewed changes

patterns/README.md Outdated Show resolved Hide resolved

MarcoIeni reviewed Jan 1, 2021

View reviewed changes

rust_rocks.md Outdated Show resolved Hide resolved

MarcoIeni reviewed Jan 1, 2021

View reviewed changes

rust_rocks.md Outdated Show resolved Hide resolved

Second grade headline

3986456

simonsan commented Jan 1, 2021

View reviewed changes

intro.md Show resolved Hide resolved

Fix headline

ac1266b

MarcoIeni reviewed Jan 1, 2021

View reviewed changes

refactoring/README.md Show resolved Hide resolved

Add book, functional and refactoring section to main readme

0ed7315

MarcoIeni reviewed Jan 1, 2021

View reviewed changes

README.md Outdated Show resolved Hide resolved

MarcoIeni reviewed Jan 1, 2021

View reviewed changes

README.md Outdated Show resolved Hide resolved

MarcoIeni reviewed Jan 1, 2021

View reviewed changes

anti_patterns/README.md Outdated Show resolved Hide resolved

simonsan added 2 commits January 2, 2021 03:31

Add small description of the KISS principle

509411e

Add introductory sentence from rust_rocks.md to newtype.md

74f0937

simonsan added 2 commits January 2, 2021 05:53

Remove rust_rocks.md from summary

9248814

Move refactoring to the end of the TOC

20ac83a

MarcoIeni reviewed Jan 2, 2021

View reviewed changes

patterns/newtype.md Show resolved Hide resolved

simonsan and others added 3 commits January 2, 2021 10:48

Update patterns/newtype.md

457cf20

Co-authored-by: Marco Ieni <11428655+MarcoIeni@users.noreply.github.com>

Remove Refactoring vom TOC

a4da83d

Remove TODO for refactoring from Readme

9c4fd15

MarcoIeni approved these changes Jan 2, 2021

View reviewed changes

simonsan merged commit de7519f into master Jan 2, 2021

simonsan deleted the add-introduction branch January 2, 2021 11:15

pickfire reviewed Jan 2, 2021

View reviewed changes

functional/README.md Show resolved Hide resolved

pickfire reviewed Jan 2, 2021

View reviewed changes

patterns/newtype.md Show resolved Hide resolved

pickfire reviewed Jan 2, 2021

View reviewed changes

refactoring/README.md Show resolved Hide resolved

simonsan removed the S-review Status: A PR that is currently under review or where a review is the next step label Jan 2, 2021

pickfire mentioned this pull request Jan 3, 2021

Use a problem as the intro for newtype pattern #153

Merged

This was referenced Jan 6, 2021

Functional programming topics to cover #172

Open

Umbrella: Repository Content (Scope)/ TODOs #116

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add introduction #117

Add introduction #117

simonsan commented Jan 1, 2021 •

edited

Loading

simonsan commented Jan 2, 2021

pickfire Jan 2, 2021 •

edited

Loading

MarcoIeni Jan 2, 2021

pickfire Jan 2, 2021

pickfire Jan 2, 2021

simonsan commented Jan 2, 2021

pickfire Jan 2, 2021 •

edited

Loading

MarcoIeni Jan 2, 2021

pickfire commented Jan 3, 2021

simonsan commented Jan 3, 2021

MarcoIeni commented Jan 3, 2021 •

edited

Loading


		The computer understands the machine code that is generated by the compiler. The language is therefore mostly beneficial to the developer. So, since we have this abstraction layer, why not put it to good use and make it simple?

		Remember the [KISS principle](https://en.wikipedia.org/wiki/KISS_principle): "Keep It Simple, Stupid". It claims that "most systems work best if they are kept simple rather than made complicated; therefore, simplicity should be a key goal in design, and unnecessary complexity should be avoided".

		[Design patterns](patterns/README.md) are methods to solve common problems when writing software.

		[Anti-patterns](anti_patterns/README.md) are methods to solve these same common problems.


		If we apply YAGNI to design patterns, we see that the features of Rust allow us to throw out many patterns. For instance, there is no need for the [strategy pattern](https://en.wikipedia.org/wiki/Strategy_pattern) in Rust because we can just use [traits](https://doc.rust-lang.org/book/traits.html).

		TODO: Maybe include some code to illustrate the traits.

Add introduction #117

Add introduction #117

Conversation

simonsan commented Jan 1, 2021 • edited Loading

simonsan commented Jan 2, 2021

pickfire Jan 2, 2021 • edited Loading

Choose a reason for hiding this comment

MarcoIeni Jan 2, 2021

Choose a reason for hiding this comment

pickfire Jan 2, 2021

Choose a reason for hiding this comment

pickfire Jan 2, 2021

Choose a reason for hiding this comment

simonsan commented Jan 2, 2021

pickfire Jan 2, 2021 • edited Loading

Choose a reason for hiding this comment

MarcoIeni Jan 2, 2021

Choose a reason for hiding this comment

pickfire commented Jan 3, 2021

simonsan commented Jan 3, 2021

MarcoIeni commented Jan 3, 2021 • edited Loading

simonsan commented Jan 1, 2021 •

edited

Loading

pickfire Jan 2, 2021 •

edited

Loading

pickfire Jan 2, 2021 •

edited

Loading

MarcoIeni commented Jan 3, 2021 •

edited

Loading