Skip to content
Permalink
Browse files

Rename code smell to 'Avoid exposing your internals'

  • Loading branch information
davidtan-tw committed Jul 19, 2019
1 parent 3dcba26 commit 3590227814a3fa5d40df074a71893f6f22dda329
Showing with 3 additions and 3 deletions.
  1. +1 −1 README.md
  2. +1 −1 docs/cheat-sheet.md
  3. +1 −1 docs/design.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

@@ -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.

@@ -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.

0 comments on commit 3590227

Please sign in to comment.
You can’t perform that action at this time.