You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@royale.apache.org by an...@apache.org on 2018/12/23 15:15:40 UTC

[royale-docs] branch master updated: Minor text changes

This is an automated email from the ASF dual-hosted git repository.

andreww pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-docs.git


The following commit(s) were added to refs/heads/master by this push:
     new fd203de  Minor text changes
fd203de is described below

commit fd203de4aa9a5d8fd55102b126eb6775d447e83c
Author: Andrew Wetmore <an...@cottage14.com>
AuthorDate: Sun Dec 23 11:15:36 2018 -0400

    Minor text changes
---
 create-an-application/code-conventions.md | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/create-an-application/code-conventions.md b/create-an-application/code-conventions.md
index a28429f..d23f52e 100644
--- a/create-an-application/code-conventions.md
+++ b/create-an-application/code-conventions.md
@@ -24,31 +24,31 @@ Warning:  This document is not complete.
 
 ## Packages
 
-Packages have lower.case.names separated by periods if needed.  MixedCase names starting with lower case is ok, but short package names are preferred so that you aren't tempted to mixCase.
+Packages have lower.case.names separated by periods if needed. Names using mixedCase (starting with lower case) are ok, but short package names are preferred so that you aren't tempted to mixCase.
 
 ## Classes
 
-Classes have MixedCase names starting with a capital letter (and no hyphens)
+Classes have MixedCase names starting with a capital letter (and no hyphens).
 
 ## Constants
 
-Constants have CAPITALIZED_NAMES separated by underscore '_'
+Constants have CAPITALIZED_NAMES with words separated by underscores '_'.
 
 ## Properties
 
-Properties have mixedCase names starting with a lower case letter
+Properties have mixedCase names starting with a lower case letter.
 
 ## Events
 
-Events have mixedCase names starting with a lower case letter
+Events have mixedCase names starting with a lower case letter.
 
 ## Event Classes
 
-Where Apache Flex had lots of event classes, Royale strives to have as few as possible, since each class has download overhead.  Royale has an Event which has an event name in the "type" field and no other payload.  A ValueEvent contains one item that might be of interest to the listener.  ValueChangeEvent has oldValue/newValue.  There may be a StringEvent and other 'typed' event classes.
+While Apache Flex had lots of event classes, Royale strives to have as few as possible since each class has download overhead. Royale has an Event which has an event name in the "type" field and no other payload. A ValueEvent contains one item that might be of interest to the listener. ValueChangeEvent has oldValue/newValue. There may be a StringEvent and other 'typed' event classes.
 
-Event constants go in the Class that will dispatch the event.  Thus the developer only has to import one class and to write the code.
+Event constants go in the class that will dispatch the event. Thus the developer only has to import one class and write the code that uses it.
 
-The reason behind this change is partly because JavaScript runtimes aren't really going to type-check the event instance.  Royale has code that will do the type-checking, but it is pretty rare to have to discriminate between event classes.  So it is best to turn off the type-checking code in Royale.
+The reason behind this change is partly that JavaScript runtimes don't really type-check event instances. Royale has code that will do the type-checking, but it is pretty rare to have to discriminate between event classes. So it is best to turn off type-checking code in Royale.
 
 To compare: