Skip to content

Indexing needs improvement throughout #131

@pearcej

Description

@pearcej

Indices should:

  1. Serve as a reference for all important concepts and code terminology.
  2. All code such as while should be placed in the index as <idx><c>while</c></idx>. Of course, you cannot see anything that is between <idx> tags, so indexing is best done at the beginning of a sentence or paragraph.
  3. ONLY be capitalized if a proper noun or an acronym or code that must be capitalized. e.g. object-oriented programming should NOT be capitalized in the index
  4. Acronyms should appear in the index separately from what they stand for. e.g., OOP and object-oriented programming should be indexed separately.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions