Skip to content

Fix Typos in Schema Docs #72

@ModernMAK

Description

@ModernMAK

Notable examples from skimming the first release

  • /sga/v2/magic-version
    • ARCHIVE_ is a hyperlink?
  • sga/v2/header
    • TOC Size has a broken link :doc:toc.rst
    • Data block size has missing punctuation
    • Clarify that 'Archive Name' matches the SGA's file name in official files
    • Maybe use a code block for the eigen values?
  • sga/v2/toc
    • File Offset Definition Offset should be File Definition Offset
    • Footnotes appear to be broken for root folder definition
    • Root Folder ~ 'which servers as' should be 'which serves as'
    • I added headings for Folder Definition and apparently forgot to describe them
    • File definition lacks a description for Name Offset
    • Data offset also has a broken sphinx link ':doc:data.rst'
  • sga/v2/data
    • File Metadata has no description for File Name
    • Clarify that File Data Hash is calculated from the File Data stored; either by explicitly mentioning the Compression Flag

In general, also avoid using acronyms like TOC, clarity over brevity and all that.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions