Titanium JIRA Archive
Titanium SDK/CLI (TIMOB)

[TIMOB-7544] Tooling: validate.py should generate errors for unsupported YAML keys

GitHub Issuen/a
TypeNew Feature
PriorityHigh
StatusClosed
ResolutionFixed
Resolution Date2012-02-13T15:35:03.000+0000
Affected Version/sn/a
Fix Version/sSprint 2012-04, Release 2.0.0, Release 1.8.2
ComponentsTooling
Labelsn/a
ReporterArthur Evans
AssigneeBill Dawson
Created2012-02-03T14:42:36.000+0000
Updated2017-03-06T18:58:32.000+0000

Description

If we insert an invalid keyword in the YAML markup, it's silently ignored. This includes errors such as: - misspelling "description" as "desciption" - including fields that aren't defined in the TDoc spec, such as "note" - leaving the s off the end of "platforms:" All of these fail silently in both validate and docgen, so the information is omitted from the docs without warning.

Comments

  1. Bill Dawson 2012-02-13

    Testing Notes: 1) Open any of our documentation .yml files and purposely mess up one of the key names (like descrption instead of description.) Or add a new key that is not [in the spec](https://wiki.appcelerator.org/display/guides/TDoc+Specification). Or do both for fun. 2) run validate.py. The messed up key(s) should be noted in the output.
  2. Bill Dawson 2012-02-13

    Pull request ready https://github.com/appcelerator/titanium_mobile/pull/1408
  3. Lee Morris 2017-03-06

    Closing ticket due to time passed.

JSON Source