archive-gh-me/xviz
1
0
Fork 0
mirror of https://github.com/aurora-opensource/xviz.git synced 2026-01-25 14:16:45 +00:00
Code Issues Projects Releases Wiki Activity
xviz/docs/STYLE_GUIDE.md
Tim Wojtaszek 9573a64424 @xviz/io consolidates general reading and writing of the 
XVIZ specified data format.

Prior to this functions and classes that operate on XVIZ data
where split across @xviz/builder and @xviz/parser. They will
be moved into @xviz/io in subsequent changes.

Motivation for this is due to @xviz/parser restructuring data that
no longer can be validated against our specification and validation
tooling.  This made it difficult to modify XVIZ and validate it is
still conforming.  Given that, this module should operate only
at the XVIZ specification level.

Highlights of @xviz/io module:
 - XVIZ data classes allow for dealing with XVIZ data regardles
   of the format specifics (binary or json)
 - Abstraction layers keep concerns isolated and provide and improve
   structure for evolving the XVIZ eco-system

Key documents are:
 - RFC ./dev-docs/003-io-module-rfc.md
 - User Docs ./docs/api-reference/io
 - Module Readme ./modules/io/README.md
2019-05-23 16:34:18 -07:00

500 B
Raw Permalink Blame History

Below is an guide for how classes should be formatted.

method(argument1, argument2)

Description of what it does.

Parameters:

  • argument1 (Type) - something
  • argument2.foo (Type) - something
  • argument2.bar (Type) - something
  • argument1 (Type) - something
  • argument2 (Object)
    • foo (Type) - something
      • bar (Type) - something

Returns: (Type) - description

Returns:

  • (Type) - description
    • field1 (Type) - desc
    • field2 (Type) - desc