Skip to content

Commit 344b5b8

Browse files
marcoienisimonsan
andauthored
Fix internal links (#143)
* Rename Readme to index to fix internal book links Co-authored-by: simonsan <[email protected]>
1 parent a46baf3 commit 344b5b8

File tree

8 files changed

+22
-22
lines changed

8 files changed

+22
-22
lines changed

SUMMARY.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
- [Introduction](./intro.md)
44

5-
- [Idioms](./idioms/README.md)
5+
- [Idioms](./idioms/index.md)
66
- [Concatenating Strings with `format!`](./idioms/concat-format.md)
77
- [Constructor](./idioms/ctor.md)
88
- [The `Default` Trait](./idioms/default.md)
@@ -16,7 +16,7 @@
1616
- [Easy doc initialization](./idioms/rustdoc-init.md)
1717
- [Temporary mutability](./idioms/temporary-mutability.md)
1818

19-
- [Design Patterns](./patterns/README.md)
19+
- [Design Patterns](./patterns/index.md)
2020
- [Builder](./patterns/builder.md)
2121
- [Compose Structs](./patterns/compose-structs.md)
2222
- [Fold](./patterns/fold.md)
@@ -26,10 +26,10 @@
2626
- [Contain unsafety in small modules](./patterns/unsafe-mods.md)
2727
- [Visitor](./patterns/visitor.md)
2828

29-
- [Anti-patterns](./anti_patterns/README.md)
29+
- [Anti-patterns](./anti_patterns/index.md)
3030
- [`#[deny(warnings)]`](./anti_patterns/deny-warnings.md)
3131
- [Deref Polymorphism](./anti_patterns/deref.md)
3232

33-
- [Functional Programming](./functional/README.md)
33+
- [Functional Programming](./functional/index.md)
3434

3535
- [Additional Resources](./additional_resources.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.

intro.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ When developing programs, we have to solve many problems. A program can be viewe
77

88
There are many problems that share the same form. Due to the fact that Rust is not object-oriented design patterns vary with respect to other object-oriented programming languages. While the details are different, since they have the same form they can be solved using the same fundamental methods.
99

10-
[Design patterns](https://rust-unofficial.github.io/patterns/patterns/index.html) are methods to solve common problems when writing software.
10+
[Design patterns](./patterns/index.md) are methods to solve common problems when writing software.
1111

12-
[Anti-patterns](https://rust-unofficial.github.io/patterns/anti_patterns/index.html) are methods to solve these same common problems.
12+
[Anti-patterns](./anti_patterns/index.md) are methods to solve these same common problems.
1313

1414
However, while design patterns give us benefits, anti-patterns create more problems.
1515

16-
[Idioms](https://rust-unofficial.github.io/patterns/idioms/index.html) are guidelines to follow when coding. They are social norms of the community.
16+
[Idioms](./idioms/index.md) are guidelines to follow when coding. They are social norms of the community.
1717
You can break them, but if you do you should have a good reason for it.
1818

1919
TODO: Mention why Rust is a bit special - functional elements, type system, borrow checker
File renamed without changes.

refactoring/README.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

refactoring/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Refactoring
2+
3+
Refactoring is very important in relation to these topics. Just as important as the other topics covered here, is how to take good code and turn it into great code.
4+
5+
We can use [design patterns](patterns/index.md) to DRY up code and generalize abstractions. We must avoid [anti-patterns](anti_patterns/index.md) while we do this. While they may be tempting to employ, their costs outweigh their benefits.
6+
7+
> Shortcuts make for long days.
8+
9+
We can also use [idioms](idioms/index.md) to structure our code in a way that is understandable.
10+
11+
## Tests
12+
13+
Tests are of vital importance during refactoring.
14+
15+
## Small changes

0 commit comments

Comments
 (0)