WPDS Düsseldorf 2014 - JavaScript Group // http://wpd.mx/dusjs

feedback.md

WPDS Düsseldorf 2014 - JavaScript - Final Result

We worked on the Number Object.

Touched Pages

• http://docs.webplatform.org/wiki/javascript/Number [In Progress]
• http://docs.webplatform.org/wiki/javascript/Number/toExponential [Ready For Review]
• http://docs.webplatform.org/wiki/javascript/Number/toFixed [Ready For Review]
• http://docs.webplatform.org/wiki/javascript/Number/toPrecision [Ready For Review]
• http://docs.webplatform.org/wiki/javascript/Number/toString [Ready For Review]

Missing / Superfluous Pages

• http://docs.webplatform.org/wiki/javascript/Number/prototype -- is this really necessary? shouldn't the prototype be explained on one central page?
• http://docs.webplatform.org/wiki/javascript/Number/constructor -- is this really necessary? this should be covered (in full) by http://docs.webplatform.org/wiki/javascript/Number
• http://docs.webplatform.org/wiki/javascript/Number/toLocaleString -- does not exist

Questions / Observations

• There is no code style guide for examples (indentation, spacing, …), and no hints for naming things.
• There is no generic "data types" page that offers an overview of what's possible, see MSDN, MDN Values, Variables and Literals and MDN Data Structures.
• should function signatures go in accordance with ECMA (fractionDigits) or natural language (digits)?

Observation on JavaScript templates:

• "JavaScript" doesn't exist as a Topic Cluster
• There is no "Compatibility" section
• There is no "Related Specifications" section
• There is no "Topics" section (only "Topic Clusters")
• There is no dedicated section for "Throws" like "Return Value"

gistfile1.md

WPDS Düsseldorf - JavaScript Group

• The Web Platform Wednesdays are working on Array so we'll skip that.
• Basic Tasks - also cross-check every entry with MDN.

General Notes

Annotated ES5 can come in handy to verify things, but http://www.ecma-international.org/ecma-262/5.1/ is the resource you want to link to in the specifications section.

The History tells you if someone has already worked on the page or it is a unreviewed import.

Examples are of utmost importance:

• Look at RegExp and figure out why a well-placed re.index = 0; might have saved you hours of figuring out why your expression isn't matching anything when either the string is mutated, or it's run twice.
• How many code style errors can you spot in RegExp/index?
• What is scriptEngineMajorVersion()?
• complex examples should be made available on code.webplatform.org and linked to in the in-page example's description

General Questions

• Is it OK to link to foreign articles explaining concepts in depth? Array is precedent for yes.
• What's the general code style guide to be used for JS Examples? Idiomatic.js? Should we create a guide page for this?

---

Number Pages on WebPlatform

• http://docs.webplatform.org/wiki/javascript/Number
• http://docs.webplatform.org/wiki/javascript/Number/constructor
• http://docs.webplatform.org/wiki/javascript/Number/constants
• http://docs.webplatform.org/wiki/javascript/Number/prototype -- necessary?
• http://docs.webplatform.org/wiki/javascript/Number/toExponential
• http://docs.webplatform.org/wiki/javascript/Number/toFixed
• http://docs.webplatform.org/wiki/javascript/Number/toPrecision
• http://docs.webplatform.org/wiki/javascript/Number/toString

• ---

• http://docs.webplatform.org/wiki/javascript/parseInt
• http://docs.webplatform.org/wiki/javascript/parseFloat
• http://docs.webplatform.org/wiki/javascript/NaN
• http://docs.webplatform.org/wiki/javascript/isNaN
• http://docs.webplatform.org/wiki/javascript/Infinity
• http://docs.webplatform.org/wiki/javascript/isFinite

References

• Number Objects
• Primitive Types (Clause 8)
• MDN Number

Questions

• Should there be a general page on primitive types vs. objects, or should new Number(123).valueOf() === 123 be explained in the constructor?
• As the constructor is explained in Number, why bother with Number/constructor?

---

Regular Expression Pages on WebPlatform

• http://docs.webplatform.org/wiki/javascript/regular_expression (Regular Expression literal?)
• http://docs.webplatform.org/wiki/javascript/regular_expression/exec
• http://docs.webplatform.org/wiki/javascript/regular_expression/test
• http://docs.webplatform.org/wiki/javascript/regular_expression/source
• http://docs.webplatform.org/wiki/javascript/regular_expression/global
• http://docs.webplatform.org/wiki/javascript/regular_expression/ignoreCase
• http://docs.webplatform.org/wiki/javascript/regular_expression/multiline

• ---

• http://docs.webplatform.org/wiki/javascript/RegExp
• http://docs.webplatform.org/wiki/javascript/RegExp/index
• http://docs.webplatform.org/wiki/javascript/RegExp/lastIndex
• http://docs.webplatform.org/wiki/javascript/RegExp/lastMatch
• http://docs.webplatform.org/wiki/javascript/RegExp/lastParen
• http://docs.webplatform.org/wiki/javascript/RegExp/input
• http://docs.webplatform.org/wiki/javascript/RegExp/1_9_Properties
• http://docs.webplatform.org/wiki/javascript/RegExp/rightContext
• http://docs.webplatform.org/wiki/javascript/RegExp/leftContext

• ---

• http://docs.webplatform.org/wiki/javascript/RegExp/toString <- missing
• http://docs.webplatform.org/wiki/javascript/RegExp/valueOf <- missing

• ---

• http://docs.webplatform.org/wiki/javascript/String/match
• http://docs.webplatform.org/wiki/javascript/String/replace <- special kind of hell
• http://docs.webplatform.org/wiki/javascript/String/search
• http://docs.webplatform.org/wiki/javascript/String/split

References

• RegExp (Regular Expression) Objects
• Regular Expression Literals
• MDN Regular Expressions

Questions

• Have "import flags" been forgotten on the JS content?
• difference between javascript/regular_expression and javascript/RegExp - merge them?

---

Error Pages on WebPlatform

• http://docs.webplatform.org/wiki/javascript/Error
• http://docs.webplatform.org/wiki/javascript/Error/name
• http://docs.webplatform.org/wiki/javascript/Error/message

• ---

• see Vendor extensions
• http://docs.webplatform.org/wiki/javascript/Error/description
• http://docs.webplatform.org/wiki/javascript/Error/number
• http://docs.webplatform.org/wiki/javascript/Error/stack
• http://docs.webplatform.org/wiki/javascript/Error/stackTraceLimit

• ---

• http://docs.webplatform.org/wiki/javascript/Error/prototype

• ---

• http://docs.webplatform.org/wiki/javascript/statements/throw
• http://docs.webplatform.org/wiki/javascript/statements/try_catch_finally

References

• Error Objects
• MDN Error

Questions

• How do we deal with non-standard properties?

---

The Tough Nut

URLs are really hard. Just explaining what a function does is not enough. encodeURIComponent should explain the difference between + and %20 for encoding spaces. Where that comes from, why that is. Who uses what? (Hint: it's ugly).

• http://docs.webplatform.org/wiki/javascript/encodeURI
• http://docs.webplatform.org/wiki/javascript/decodeURI
• http://docs.webplatform.org/wiki/javascript/encodeURIComponent
• http://docs.webplatform.org/wiki/javascript/decodeURIComponent
• http://docs.webplatform.org/wiki/javascript/escape
• http://docs.webplatform.org/wiki/javascript/unescape

Working on: http://docs.webplatform.org/wiki/javascript/Number/toString

Observation on JavaScript templates:

• "JavaScript" doesn't exist as a Topic Cluster
• There is no "Compatibility" section
• There is no "Related Specifications" section
• There is no "Topics" section (only "Topic Clusters")
• There is no dedicated section for "Throws" like "Return Value"

Reading through the Ecmascript docs and when it comes down to Number they actually start with the Number Type as defined in sec8.5 so will add some info on this.

Numbers should explain Two's Complement - or at least hint at it

Noticed JavaScript data types are missing, eg: http://docs.webplatform.org/wiki/javascript/data-types
MSDN has a page here

Finished http://docs.webplatform.org/wiki/javascript/Number/toFixed

Found pretty good source: http://www.diveintojavascript.com/core-javascript-reference/the-number-object

Hey @rodneyrehm, I would like to write from time to time on ... which part should I choose at the next step?