tomee-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jlmonte...@apache.org
Subject svn commit: r1846984 - /tomee/site/trunk/content/dev/writing-examples.mdtext
Date Tue, 20 Nov 2018 09:19:28 GMT
Author: jlmonteiro
Date: Tue Nov 20 09:19:28 2018
New Revision: 1846984

URL: http://svn.apache.org/viewvc?rev=1846984&view=rev
Log:
Fix some typos

Modified:
    tomee/site/trunk/content/dev/writing-examples.mdtext

Modified: tomee/site/trunk/content/dev/writing-examples.mdtext
URL: http://svn.apache.org/viewvc/tomee/site/trunk/content/dev/writing-examples.mdtext?rev=1846984&r1=1846983&r2=1846984&view=diff
==============================================================================
--- tomee/site/trunk/content/dev/writing-examples.mdtext (original)
+++ tomee/site/trunk/content/dev/writing-examples.mdtext Tue Nov 20 09:19:28 2018
@@ -4,19 +4,19 @@ Writing an example is easy.  Any example
 
 Writing examples that can be used in a presentations is hard.
 
-Some basic guideliness of writing examples:
+Some basic guidelines of writing examples:
 
  - focus on one idea per example
  - keep examples short
     - one test case
     - minimal code to make the point
  - avoid showing an entire API in one example, if possible
- - be concious of the cost of "setting the stage"
+ - be conscious of the cost of "setting the stage"
  - if examples get too big, split it
 
 # Noise vs signal
 
-It takes time to learn the example scenario (noise).  You need to learn the scenario before
you can start to see the imporant parts (signal).
+It takes time to learn the example scenario (noise).  You need to learn the scenario before
you can start to see the important parts (signal).
 
 Be very mindful of your noise to signal ratio.
 
@@ -28,7 +28,7 @@ You should be able to explain the entire
 
 If there are five ways to do the same thing, avoid making five different scenarios.  Copy
the example to a new directory, and tweak it to show the variation.
 
-So say you used objects `Green`, `Square` and `Checkers` to show the basic concept and you
wish to show the next variation of that same concecpt.  It is tempting to add to the same
+So say you used objects `Green`, `Square` and `Checkers` to show the basic concept and you
wish to show the next variation of that same concept.  It is tempting to add to the same
 example objects `Yellow`, `Triangle` and `PolkaDots`.
 
 Avoid that.  Copy `Green`, `Square` and `Checkers` to a new example, change the package name,
and update the few lines needed to show the difference.



Mime
View raw message