Rename code smell to 'Avoid exposing your internals'

davified · Jul 19, 2019 · 3590227 · 3590227
1 parent 3dcba26
commit 3590227
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@
     - Use default arguments instead of short circuiting or conditionals
     - Don't use flags as function parameters
 - [Design](docs/design.md)
-    - Set boundaries (Keep implementation details hidden)
+    - Avoid exposing your internals (Keep implementation details hidden)
 
 ## Introduction
 

diff --git a/docs/cheat-sheet.md b/docs/cheat-sheet.md
@@ -184,7 +184,7 @@ This is by far the most important rule in software engineering. When functions d
 
 ## Design
 
-### Don't expose your internals (Keep implementation details hidden)
+### Avoid exposing your internals (Keep implementation details hidden)
 
 Functions and classes simplify our code by abstracting away complicated implementation details and replacing them with a simpler representation - its name. When implementation details are all laid bare in a Jupyter notebook without any abstractions (functions), we are forced to understand the **how**'s in order to find out **what**'s happening.
 

diff --git a/docs/design.md b/docs/design.md
@@ -1,6 +1,6 @@
 ## **Design**
 
-### Set boundaries (Keep implementation details hidden)
+### Avoid exposing your internals (Keep implementation details hidden)
 
 Functions and classes simplify our code by abstracting away complicated implementation details and replacing them with a simpler representation - its name. When implementation details are all laid bare in a Jupyter notebook without any abstractions (functions), we are forced to understand the **how**'s in order to find out **what**'s happening.