eclipse-archived/ceylon

Missing definitions in 'Ceylon Tour'

Closed this issue · 1 comments

Whenever a language concept is used in the Ceylon Tour without first being defined, or it is introduced without giving a proper/full definition, it would be prudent to make the first word occurrence of that concept be a link to the proper definition of the concept (as found in eg. the Ceylon reference page)

An operable way to fix 99%-100% of this bug would be to take each concept defined in the reference and see where its word first occurs in the tour (text search). Then make that occurrence into a link.

The list below is just for guidance. It can contain errors, or be subjective, without that immediately implying that this bug report is invalid. And it is most likely incomplete.

List of concepts with vague, delayed, or missing definitions in the Ceylon tour:

  • Attribute
  • Reference
  • Initializer
  • Field
  • Value
  • getter
  • method
  • getter method
  • member
  • <Value>
  • refine

@loldrup, you can hit the "Edit" link on the top right corner of any tour page and submit a pull request with proposed corrections or enhancements to documentation. The documentation also uses a different github repo from this one, and that's where documentation issues should be filed.